modify unused apis, fix docs

kkb0318 · Jun 1, 2024 · 6016727 · 6016727
1 parent 6121971
commit 6016727
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -67,7 +67,10 @@ spec:
 
 Check the IRSASetup custom resource status to verify whether it is set to true.
 
-5. Modify kube-apiserver Settings
+> [!NOTE]
+> Please ensure that only one IRSASetup resource is created.
+
+4. Modify kube-apiserver Settings
 
 If the IRSASetup status is true, a key file (Name: `irsa-manager-key` , Namespace: `kube-system` ) will be created. This is used for signing tokens in the kubernetes API.
 Execute the following commands on the control plane server to save the public and private keys locally for Kubernetes signatures:

diff --git a/api/v1alpha1/irsasetup_types.go b/api/v1alpha1/irsasetup_types.go
@@ -39,9 +39,6 @@ type IRSASetupSpec struct {
 	// Discovery configures the IdP Discovery process, essential for setting up IRSA by locating
 	// the OIDC provider information.
 	Discovery Discovery `json:"discovery"`
-
-	// Auth contains authentication configuration details.
-	Auth Auth `json:"auth,omitempty"`
 }
 
 // Discovery holds the configuration for IdP Discovery, which is crucial for locating
@@ -60,21 +57,6 @@ type S3Discovery struct {
 	BucketName string `json:"bucketName"`
 }
 
-// Auth holds the authentication configuration details.
-type Auth struct {
-	// SecretRef specifies the reference to the Kubernetes secret containing authentication details.
-	SecretRef SecretRef `json:"secretRef"`
-}
-
-// SecretRef contains the reference to a Kubernetes secret.
-type SecretRef struct {
-	// Name specifies the name of the secret.
-	Name string `json:"name"`
-
-	// Namespace specifies the namespace of the secret.
-	Namespace string `json:"namespace,omitempty"`
-}
-
 // IRSASetupStatus defines the observed state of IRSASetup
 type IRSASetupStatus struct {
 	SelfHostedSetup []metav1.Condition `json:"selfHostedSetup,omitempty"`

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/irsa.kkb0318.github.io_irsasetups.yaml b/config/crd/bases/irsa.kkb0318.github.io_irsasetups.yaml
@@ -44,25 +44,6 @@ spec:
           spec:
             description: IRSASetupSpec defines the desired state of IRSASetup
             properties:
-              auth:
-                description: Auth contains authentication configuration details.
-                properties:
-                  secretRef:
-                    description: SecretRef specifies the reference to the Kubernetes
-                      secret containing authentication details.
-                    properties:
-                      name:
-                        description: Name specifies the name of the secret.
-                        type: string
-                      namespace:
-                        description: Namespace specifies the namespace of the secret.
-                        type: string
-                    required:
-                    - name
-                    type: object
-                required:
-                - secretRef
-                type: object
               cleanup:
                 description: |-
                   Cleanup, when enabled, allows the IRSASetup to perform garbage collection

diff --git a/docs/api.md b/docs/api.md
@@ -14,22 +14,6 @@ Package v1alpha1 contains API Schema definitions for the irsa v1alpha1 API group
 
 
 
-#### Auth
-
-
-
-Auth holds the authentication configuration details.
-
-
-
-_Appears in:_
-- [IRSASetupSpec](#irsasetupspec)
-
-| Field | Description | Default | Validation |
-| --- | --- | --- | --- |
-| `secretRef` _[SecretRef](#secretref)_ | SecretRef specifies the reference to the Kubernetes secret containing authentication details. |  |  |
-
-
 #### Discovery
 
 
@@ -118,7 +102,6 @@ _Appears in:_
 | `cleanup` _boolean_ | Cleanup, when enabled, allows the IRSASetup to perform garbage collection<br />of resources that are no longer needed or managed. |  |  |
 | `mode` _string_ | Mode specifies the mode of operation. Can be either "selfhosted" or "eks". |  |  |
 | `discovery` _[Discovery](#discovery)_ | Discovery configures the IdP Discovery process, essential for setting up IRSA by locating<br />the OIDC provider information. |  |  |
-| `auth` _[Auth](#auth)_ | Auth contains authentication configuration details. |  |  |
 
 
 
@@ -177,22 +160,5 @@ _Appears in:_
 | `bucketName` _string_ | BucketName is the name of the S3 bucket that hosts the OIDC discovery information. |  |  |
 
 
-#### SecretRef
-
-
-
-SecretRef contains the reference to a Kubernetes secret.
-
-
-
-_Appears in:_
-- [Auth](#auth)
-
-| Field | Description | Default | Validation |
-| --- | --- | --- | --- |
-| `name` _string_ | Name specifies the name of the secret. |  |  |
-| `namespace` _string_ | Namespace specifies the namespace of the secret. |  |  |
-
-