Skip to content

Commit b96caa4

Browse files
correct KubeConfigFileAuthentication name
1 parent ae706f2 commit b96caa4

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

CodeFlareSDK_Design_Doc.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Our aim is to simplify the process of generating valid AppWrappers for RayCluste
4343

4444
With a valid AppWrapper, we will use the Kubernetes python client to apply the AppWrapper to our Kubernetes cluster via a call to `cluster.up()`
4545

46-
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 via `cluster.status()` and `cluster,details()`.
46+
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 via `cluster.status()` and `cluster.details()`.
4747

4848
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.
4949

@@ -67,7 +67,7 @@ The SDK itself will not enforce any authentication, however, it will provide sim
6767

6868
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.
6969

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

7272
In either case, users can log out and clear the authentication inputs with `.logout()`
7373

@@ -105,7 +105,7 @@ We will rely on the kubernetes cluster’s default security, where users cannot
105105
## Deployment and Rollout
106106

107107
* Deployment strategy and considerations
108-
* The SDK is part of the wider project codeflare ecosystem, and serves as the primary interaction layer between the user and the rest of the codeflare stack. Therefore, deployment and realse strategies cannot occur in isolation, but must take into consideration the current state of the other pieces of the codeflare stack (MCAD, KubeRay, Instascale)
108+
* The SDK is part of the wider project codeflare ecosystem, and serves as the primary interaction layer between the user and the rest of the codeflare stack. Therefore, deployment and release strategies cannot occur in isolation, but must take into consideration the current state of the other pieces of the codeflare stack (MCAD, KubeRay, Instascale)
109109

110110
* Versioning and release management
111111
* Releases are performed automatically via a github action.

0 commit comments

Comments
 (0)