Skip to content

Commit 561486d

Browse files
upadate Authentication section
1 parent b7395b4 commit 561486d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

CodeFlareSDK_Design_Doc.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ With a valid AppWrapper, we will use the Kubernetes python client to apply the A
4545

4646
We will also use the Kubernetes python client to get information about both the RayCluster and AppWrapper custom resources to monitor the status of our Framework Cluster.
4747

48+
The RayCluster deployed on your kubernetes cluster can be interacted with in two ways: Either through an interactive session via `ray.init()` or through the submission of batch jobs.
49+
4850
Finally we will use the Kubernetes python client to delete the AppWrapper via `Cluster.down()`
4951

5052
### Training Jobs:
@@ -61,13 +63,13 @@ After the job is submitted, a user can monitor its progress via `job.status()`
6163

6264
Since we are dealing with controlling and accessing different resources on a Kubernetes cluster, the user will need to have certain permissions on that cluster granted to them by their cluster administrator.
6365

64-
The SDK itself will not enforce any authentication, however, it will provide simple interfaces to allow users to authenticate themselves to their Kuberentes cluster. All operations that require authentication to the cluster will rely on a properly authenticated kubeconfig file in the users environment.
66+
The SDK itself will not enforce any authentication, however, it will provide simple interfaces to allow users to authenticate themselves to their Kubernetes cluster. By default, if a user is already authenticated with a `~/.kube/config` file, that authentication will automatically be picked up by the SDK and no additional authentication is required.
6567

66-
Users can authorize themselves by calling `TokenAuthentication()` and providing their access token and server address. This will update an existing kubeconfig file if one exists, or generate a new one if one does not exist. Users are also able to toggle whether or not they want to skip tls verification.
68+
Users can authorize themselves by calling `TokenAuthentication()` and providing their access token and server address. This will populate the Kubernetes python configuration of the ApiClient object and allow users to be properly authenticated to the cluster. Users are also able to toggle whether or not they want to skip tls verification.
6769

68-
Alternatively users can provide their own custom kubconfig file with `KubeConfigAuthentication()` and pass it the correct path.
70+
Alternatively users can provide their own custom kubeconfig file with `KubeConfigAuthentication()` and pass it the correct path.
6971

70-
In either case, users can log out of their cluster with `.logout()`
72+
In either case, users can log out and clear the authentication inputs with `.logout()`
7173

7274
## Alternatives Considered
7375

0 commit comments

Comments
 (0)