Skip to content

Commit

Permalink
v2.0.0 release (#20)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Mattsson <[email protected]>
  • Loading branch information
datamattsson authored Oct 2, 2021
1 parent d39adf0 commit aa5e623
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ The recommended way to install the CSP is to use Helm, it automatically fulfill

- Learn more about the Helm chart on [Artifact Hub](https://artifacthub.io/packages/helm/truenas-csp/truenas-csp)

### HPE CSI Driver for Kubernetes
### Install HPE CSI Driver for Kubernetes separately (not recommended)

The HPE CSI Driver may be installed using either a Helm Chart, Operator or directly with manifests. Directly below is the complete procedures for the "[Advanced install](https://scod.hpedev.io/csi_driver/deployment.html#advanced_install)".

**Note:** The TrueNAS CORE Container Storage Provider Helm Chart has a dependency on the HPE CSI Driver for Kubernetes Helm Chart and makes it a lot easier to manage configuration during runtime. Consider using Helm to deploy the CSP over the YAML manifests.
**Note:** The [TrueNAS CORE Container Storage Provider Helm Chart](https://artifacthub.io/packages/helm/truenas-csp/truenas-csp) has a dependency on the HPE CSI Driver for Kubernetes Helm Chart and makes it a lot easier to manage configuration during runtime. Consider using Helm to deploy the CSP over the YAML manifests.

Install HPE CSI Driver using manifests:

```
kubectl create -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.0.0/hpe-linux-config.yaml
kubectl create -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.0.0/hpe-csi-k8s-1.20.yaml
kubectl create -f https://raw.githubusercontent.com/hpe-storage/co-deployments/master/yaml/csi-driver/v2.0.0/hpe-csi-k8s-1.21.yaml
```

Install the TrueNAS CORE CSP using manifests:
Expand Down Expand Up @@ -57,7 +57,7 @@ stringData:
backend: TrueNAS CORE management IP address
```

**Hint:** Generate an API key by clicking the cog in the upper right corner of the TrueNAS CORE web UI. What you name the key or the `Secret` `{.stringData.username}` does not matter as it's not being used or referenced during runtime. For tracking purposes it might be a good idea to name the key the same as the username put into the `Secret`.
**Hint:** Generate an API key by clicking the cog in the upper right corner of the TrueNAS CORE web UI (FreeNAS does NOT support API keys). What you name the key or the `Secret` `{.stringData.username}` does not matter as it's not being used or referenced during runtime. For tracking purposes it might be a good idea to name the key the same as the username put into the `Secret`.

### Configure TrueNAS/FreeNAS

Expand Down
6 changes: 3 additions & 3 deletions docs/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ entries:
artifacthub.io/prerelease: "true"
apiVersion: v2
appVersion: 2.0.0
created: "2021-09-06T18:52:10.703755976-07:00"
created: "2021-10-02T10:25:01.735218208-07:00"
dependencies:
- name: hpe-csi-driver
repository: ""
version: 2.0.0
description: TrueNAS CORE Container Storage Provider Helm chart for Kubernetes
digest: 53dd8e6c9c8c1e5f784a98aab543e28314bda3d5cf48a446c7d5b3b8fae3e50b
digest: 27b33b27cb4b7a7b2ecee141957346e8eb597e6ee1028a16e8c3701729f3fac3
home: https://github.com/hpe-storage/truenas-csp
icon: https://hpe-storage.github.io/truenas-csp/assets/icon.svg
keywords:
Expand All @@ -34,4 +34,4 @@ entries:
urls:
- truenas-csp-1.0.0.tgz
version: 1.0.0
generated: "2021-09-06T18:52:10.70249933-07:00"
generated: "2021-10-02T10:25:01.732126837-07:00"
Binary file modified docs/truenas-csp-1.0.0.tgz
Binary file not shown.
6 changes: 3 additions & 3 deletions helm/charts/truenas-csp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ helm uninstall my-truenas-csp -n hpe-storage

**Note**: Due to a limitation in Helm, CRDs are not deleted as part of the chart uninstall.

## Using persistent storage to Kubernetes with TrueNAS and FreeNAS
## Provisioning persistent storage to Kubernetes with TrueNAS and FreeNAS

The appliance that is intended to be used with the CSI driver must be configured properly before it can be used. Follow the [INSTALL](https://github.com/hpe-storage/truenas-csp/blob/master/INSTALL.md) document to learn more.
The appliance that is intended to be used with the CSI driver must be configured properly before it can be used. Follow the [INSTALL](https://github.com/hpe-storage/truenas-csp/blob/master/INSTALL.md#configure-csi-driver) document to learn more.

Also, it's helpful to be familiar with [persistent storage concepts](https://kubernetes.io/docs/concepts/storage/volumes/) in Kubernetes prior to deploying stateful workloads.
Also, it's helpful to be familiar with [persistent storage concepts](https://kubernetes.io/docs/concepts/storage/) in Kubernetes prior to deploying stateful workloads.

## Community

Expand Down

0 comments on commit aa5e623

Please sign in to comment.