Skip to content

Commit f62bcce

Browse files
committed
docs: replace all remaining TrueNAS references with NASty
Complete renaming across docs, charts, scripts, and tests: - charts: .Values.truenas.* → .Values.nasty.*, all templates updated - scripts: cleanup-all-truenas-resources.sh → cleanup-all-nasty-resources.sh - integration tests: TRUENAS_HOST/API_KEY/POOL → NASTY_HOST/API_KEY/POOL - docs: QUICKSTART, DEPLOYMENT, FEATURES, ADOPTION, e2e README updated - Delete COMPARISON-*.md docs (no longer relevant for NASty) - CONTRIBUTING.md, SECURITY.md, sonar-project.properties updated - dashboard, kind-config.yaml, deploy/README.md updated
1 parent 4cc65d3 commit f62bcce

43 files changed

Lines changed: 317 additions & 735 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/qemu-e2e.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -307,10 +307,10 @@ jobs:
307307
upgrade --install nasty-csi-driver ./charts/nasty-csi-driver
308308
--namespace kube-system
309309
--wait --timeout 8m
310-
--set "truenas.url=wss://${NASTY_HOST}/api/current"
311-
--set "truenas.apiKey=${NASTY_API_KEY}"
312-
--set "truenas.pool=${NASTY_POOL}"
313-
--set "truenas.skipTLSVerify=true"
310+
--set "nasty.url=wss://${NASTY_HOST}/api/current"
311+
--set "nasty.apiKey=${NASTY_API_KEY}"
312+
--set "nasty.pool=${NASTY_POOL}"
313+
--set "nasty.skipTLSVerify=true"
314314
--set "image.repository=ghcr.io/fenio/nasty-csi"
315315
--set "image.tag=qemu-test"
316316
--set "image.pullPolicy=Never"

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ jobs:
111111
helm template nasty-csi charts/nasty-csi-driver \
112112
--namespace kube-system \
113113
--set nasty.url="wss://NASTY_IP/api/current" \
114-
--set truenas.apiKey="REPLACE_WITH_API_KEY" \
114+
--set nasty.apiKey="REPLACE_WITH_API_KEY" \
115115
--set storageClasses[0].name=nasty-csi-nfs \
116116
--set storageClasses[0].enabled=true \
117117
--set storageClasses[0].protocol=nfs \

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Before creating bug reports, please check existing issues to avoid duplicates. W
1818
- **Actual behavior** - What actually happened
1919
- **Environment details**:
2020
- Kubernetes version
21-
- TrueNAS version
21+
- NASty version
2222
- CSI driver version
2323
- Storage protocol (NFS/NVMe-oF)
2424
- **Logs** - Include relevant logs from controller and node pods
@@ -95,7 +95,7 @@ nasty-csi/
9595
│ └── nasty-csi-driver/ # Driver entry point
9696
├── pkg/ # Library code
9797
│ ├── driver/ # CSI driver implementation
98-
│ └── nastyapi/ # TrueNAS API client
98+
│ └── nastyapi/ # NASty API client
9999
├── tests/ # Test files
100100
│ ├── e2e/ # End-to-end tests
101101
│ └── integration/ # Integration tests
@@ -144,9 +144,9 @@ Integration tests use [Ginkgo](https://onsi.github.io/ginkgo/) and run automatic
144144
go install github.com/onsi/ginkgo/v2/ginkgo@latest
145145

146146
# Set required environment variables
147-
export TRUENAS_HOST="your-truenas-ip"
148-
export TRUENAS_API_KEY="your-api-key"
149-
export TRUENAS_POOL="your-pool"
147+
export NASTY_HOST="your-nasty-ip"
148+
export NASTY_API_KEY="your-api-key"
149+
export NASTY_POOL="your-pool"
150150

151151
# Run NFS E2E tests
152152
ginkgo -v --timeout=25m ./tests/e2e/nfs/...
@@ -203,7 +203,7 @@ feat: Add support for volume expansion in NVMe-oF
203203
204204
fix: Correct NFS mount options for better performance
205205
206-
docs: Update quickstart guide with TrueNAS 24.04 specifics
206+
docs: Update quickstart guide with NASty specifics
207207
208208
test: Add integration tests for NVMe-oF volume lifecycle
209209
```

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ test-coverage:
104104
test-all: test-unit test-sanity
105105
@echo "All tests completed"
106106

107-
# E2E tests (requires Ginkgo CLI and TrueNAS connection)
107+
# E2E tests (requires Ginkgo CLI and NASty connection)
108108
test-e2e:
109109
@echo "Running all E2E tests..."
110110
ginkgo -v --timeout=60m ./tests/e2e/...

README.md

Lines changed: 49 additions & 97 deletions
Large diffs are not rendered by default.

SECURITY.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,26 @@ We will acknowledge your report within 48 hours and provide a timeline for a fix
2525
### Credential Management
2626

2727
**API Keys and Secrets:**
28-
- TrueNAS API keys are stored in Kubernetes Secrets
28+
- NASty API keys are stored in Kubernetes Secrets
2929
- Secrets should use RBAC to restrict access
3030
- Never commit credentials to git
3131
- Use `.local.yaml` files for local development (automatically ignored by git)
3232

3333
**Best Practices:**
3434
- Use dedicated API keys with minimal required permissions
3535
- Rotate API keys regularly
36-
- Enable TrueNAS API audit logging
36+
- Enable NASty API audit logging
3737
- Monitor API key usage
3838

3939
### Network Security
4040

4141
**TLS/SSL:**
42-
- Always use `wss://` (WebSocket Secure) for TrueNAS API connections
42+
- Always use `wss://` (WebSocket Secure) for NASty API connections
4343
- Verify TLS certificates in production
4444
- For self-signed certificates, understand the security implications
4545

4646
**Network Isolation:**
47-
- Restrict network access to TrueNAS management interface
47+
- Restrict network access to NASty management interface
4848
- Use firewalls to limit access to storage ports:
4949
- NFS: TCP 2049
5050
- NVMe-oF: TCP 4420
@@ -53,7 +53,7 @@ We will acknowledge your report within 48 hours and provide a timeline for a fix
5353
**Self-Hosted Runners:**
5454
- Use private GitHub repositories to prevent malicious PR execution
5555
- Isolate runners on dedicated network segments
56-
- Use Wireguard VPN for secure communication with TrueNAS
56+
- Use Wireguard VPN for secure communication with NASty
5757
- Regularly update runner systems and dependencies
5858

5959
### Kubernetes Security
@@ -71,24 +71,24 @@ We will acknowledge your report within 48 hours and provide a timeline for a fix
7171
**Secrets:**
7272
```bash
7373
# Create secret with proper permissions
74-
kubectl create secret generic truenas-csi-secret \
74+
kubectl create secret generic nasty-csi-secret \
7575
--from-literal=api-key=YOUR_API_KEY \
76-
--from-literal=api-url=wss://YOUR-TRUENAS-IP:443/api/current \
76+
--from-literal=api-url=wss://YOUR-NASTY-IP:443/api/current \
7777
--namespace kube-system
7878

7979
# Restrict access
8080
kubectl create role secret-reader \
8181
--verb=get \
8282
--resource=secrets \
83-
--resource-name=truenas-csi-secret \
83+
--resource-name=nasty-csi-secret \
8484
--namespace kube-system
8585
```
8686

8787
### Data Security
8888

8989
**Volume Data:**
90-
- Data in volumes is subject to TrueNAS permissions and encryption
91-
- Use TrueNAS dataset encryption for sensitive data
90+
- Data in volumes is subject to NASty permissions and encryption
91+
- Use NASty dataset encryption for sensitive data
9292
- Implement backup strategies
9393
- Consider volume encryption at application level for additional security
9494

@@ -120,8 +120,8 @@ kubectl create role secret-reader \
120120
kubectl logs -n kube-system -l app.kubernetes.io/name=nasty-csi-driver
121121
```
122122

123-
**TrueNAS Audit:**
124-
- Enable TrueNAS API audit logging
123+
**NASty Audit:**
124+
- Enable NASty API audit logging
125125
- Review logs for unauthorized access attempts
126126
- Monitor dataset access patterns
127127

@@ -169,4 +169,4 @@ This driver does not currently undergo formal security audits or compliance cert
169169

170170
- [Kubernetes Secrets Management](https://kubernetes.io/docs/concepts/configuration/secret/)
171171
- [CSI Driver Security Considerations](https://kubernetes-csi.github.io/docs/)
172-
- [TrueNAS Security Best Practices](https://www.truenas.com/docs/)
172+
-

charts/nasty-csi-driver/Chart.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: nasty-csi-driver
3-
description: A Helm chart for TrueNAS Scale CSI Driver - providing NFS, NVMe-oF, and iSCSI storage for Kubernetes (requires TrueNAS Scale 25.10+)
3+
description: A Helm chart for NASty CSI Driver - providing NFS, NVMe-oF, and iSCSI storage for Kubernetes
44

55
# A chart can be either an 'application' or a 'library' chart.
66
type: application
@@ -17,7 +17,7 @@ appVersion: "v0.17.3"
1717
keywords:
1818
- storage
1919
- csi
20-
- truenas
20+
- nasty
2121
- nfs
2222
- nvmeof
2323
- iscsi
@@ -31,4 +31,4 @@ maintainers:
3131
email: fenio@debian.org
3232
url: https://github.com/fenio
3333

34-
icon: https://www.truenas.com/wp-content/uploads/2023/01/TrueNAS_Open_Storage.png
34+
icon: https://github.com/nasty-project/nasty-csi/raw/main/docs/nasty-logo.png

0 commit comments

Comments
 (0)