Skip to content

Commit

Permalink
docs(installation): added installation command
Browse files Browse the repository at this point in the history
Signed-off-by: Mateusz Urbanek <[email protected]>
  • Loading branch information
shanduur committed Dec 13, 2023
1 parent 42f832c commit ea08e3d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,27 @@ Follow these steps to get started with Linode COSI Driver:

1. **Prerequisites:**
1. Install COSI Custom Resource Definitions.
```
```sh
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-api
```

2. Install COSI Controller.
```
```sh
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-controller
```

2. **Installation:**
<!-- TODO: write install instructions -->
1. Create new API token in [Akamai Cloud Manager](https://cloud.linode.com/profile/tokens). The token must be configured with the following permissions:
- **Object Storage** - Read/Write

2. Install Linode COSI Driver using Helm.
```sh
helm install linode-cosi-driver \
./helm/linode-cosi-driver/ \
--set=apiToken=<YOUR_LINODE_API_TOKEN> \
--namespace=linode-cosi-driver \
--create-namespace
```

3. **Usage:**
<!-- TODO: write usage examples -->
Expand Down
4 changes: 2 additions & 2 deletions helm/linode-cosi-driver/templates/Secret.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{{- if not .Values.secretRef }}
{{- if not .Values.secret.ref }}
apiVersion: v1
kind: Secret
type: Opaque
Expand All @@ -17,6 +17,6 @@ data:
LINODE_API_URL: {{ .Values.linodeApiUrl | b64enc }}
{{- end }}
{{- if .Values.linodeApiVersion -}}
LINODE_API_URL: {{ .Values.linodeApiVersion | b64enc }}
LINODE_API_VERSION: {{ .Values.linodeApiVersion | b64enc }}
{{- end }}
{{- end }}

0 comments on commit ea08e3d

Please sign in to comment.