Skip to content

Commit d36f902

Browse files
author
Jesus Carrillo
committed
ocs: clarify DRIVER_ROLE behavior for CSI driver
- Specify that `DRIVER_ROLE=controller` requires `LINODE_TOKEN` and initializes the CSI Controller with Linode API access. - Specify that `DRIVER_ROLE=nodeserver` does not require `LINODE_TOKEN` and only launches the NodeServer, operating without any Linode API calls.
1 parent 9a986d4 commit d36f902

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/deployment.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,9 +167,16 @@ kubectl apply -f https://raw.githubusercontent.com/linode/linode-blockstorage-cs
167167
- The volume must be unmounted from all nodes before resizing.
168168
It could be unmounted by deleting the pod using the volume or by using the `kubectl delete pod <pod-name>` command.
169169
170-
5. Driver role
170+
5. Driver Role Configuration
171171
172-
The environment variable DRIVER_ROLE can be either nodeserver or controller
172+
Set the `DRIVER_ROLE` environment variable to control which CSI components load:
173173
174-
- When set to controller the LINODE_TOKEN is mandatory, and starts the controller and access to the Linode API is required.
175-
- When set to nodeserver the controller start LINODE_TOKEN and access to the Linode API is not required.
174+
- **controller**
175+
- **Prerequisite**: `LINODE_TOKEN` **must** be defined.
176+
- **Behavior**: Boots the CSI Controller service.
177+
- **API**: Actively calls the Linode API to provision, attach and manage volumes.
178+
179+
- **nodeserver**
180+
- **Prerequisite**: `LINODE_TOKEN` **not required**.
181+
- **Behavior**: Launches only the NodeServer endpoint.
182+
- **API**: Operates entirely offline—no Linode API interactions.

0 commit comments

Comments
 (0)