From 2fef29730956792c401e593ec9956ace3f5047a8 Mon Sep 17 00:00:00 2001 From: MichaelClifford Date: Wed, 19 Jul 2023 16:18:50 -0400 Subject: [PATCH] upadate Authentication section --- CodeFlareSDK_Design_Doc.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CodeFlareSDK_Design_Doc.md b/CodeFlareSDK_Design_Doc.md index 9ae84a570..685ac836d 100644 --- a/CodeFlareSDK_Design_Doc.md +++ b/CodeFlareSDK_Design_Doc.md @@ -61,13 +61,13 @@ After the job is submitted, a user can monitor its progress via `job.status()` 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. -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. +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. -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. +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. -Alternatively users can provide their own custom kubconfig file with `KubeConfigAuthentication()` and pass it the correct path. +Alternatively users can provide their own custom kubeconfig file with `KubeConfigAuthentication()` and pass it the correct path. -In either case, users can log out of their cluster with `.logout()` +In either case, users can log out and clear the authentication inputs with `.logout()` ## Alternatives Considered