Skip to content

Commit 34a3bfc

Browse files
authored
[OIDC] Fix CRD field descriptions (#183)
# Summary Updates CRD fields descriptions related to OIDC. ## Proof of Work Only documentation change. ## Checklist - [ ] Have you linked a jira ticket and/or is the ticket in the title? - [ ] Have you checked whether your jira ticket required DOCSP changes? - [ ] Have you checked for release_note changes? ## Reminder (Please remove this when merging) - Please try to Approve or Reject Changes the PR, keep PRs in review as short as possible - Our Short Guide for PRs: [Link](https://docs.google.com/document/d/1T93KUtdvONq43vfTfUt8l92uo4e4SEEvFbIEKOxGr44/edit?tab=t.0) - Remember the following Communication Standards - use comment prefixes for clarity: * **blocking**: Must be addressed before approval. * **follow-up**: Can be addressed in a later PR or ticket. * **q**: Clarifying question. * **nit**: Non-blocking suggestions. * **note**: Side-note, non-actionable. Example: Praise * --> no prefix is considered a question
1 parent febd854 commit 34a3bfc

File tree

8 files changed

+46
-61
lines changed

8 files changed

+46
-61
lines changed

api/v1/mdb/mongodb_types.go

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,20 +1061,18 @@ type Ldap struct {
10611061
}
10621062

10631063
type OIDCProviderConfig struct {
1064-
// Unique label that identifies this configuration. This label is visible to your Ops Manager users and is used when
1065-
// creating users and roles for authorization. It is case-sensitive and can only contain the following characters:
1064+
// Unique label that identifies this configuration. It is case-sensitive and can only contain the following characters:
10661065
// - alphanumeric characters (combination of a to z and 0 to 9)
10671066
// - hyphens (-)
10681067
// - underscores (_)
10691068
// +kubebuilder:validation:Pattern="^[a-zA-Z0-9-_]+$"
10701069
// +kubebuilder:validation:Required
10711070
ConfigurationName string `json:"configurationName"`
10721071

1073-
// Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Provider
1072+
// Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Connect Provider
10741073
// Configuration Document, which should be available in the /.wellknown/open-id-configuration endpoint.
10751074
// For MongoDB 7.0, 7.3, and 8.0+, the combination of issuerURI and audience must be unique across OIDC provider configurations.
10761075
// For other MongoDB versions, the issuerURI itself must be unique.
1077-
10781076
// +kubebuilder:validation:Required
10791077
IssuerURI string `json:"issuerURI"`
10801078

@@ -1095,13 +1093,12 @@ type OIDCProviderConfig struct {
10951093
UserClaim string `json:"userClaim"`
10961094

10971095
// The identifier of the claim that includes the principal's IdP user group membership information.
1098-
// Accept the default value unless your IdP uses a different claim, or you need a custom claim.
10991096
// Required when selected GroupMembership as the authorization type, ignored otherwise
11001097
// +kubebuilder:validation:Optional
11011098
GroupsClaim *string `json:"groupsClaim"`
11021099

1103-
// Configure single-sign-on for human user access to Ops Manager deployments with Workforce Identity Federation.
1104-
// For programmatic, application access to Ops Manager deployments use Workload Identity Federation.
1100+
// Configure single-sign-on for human user access to deployments with Workforce Identity Federation.
1101+
// For programmatic, application access to deployments use Workload Identity Federation.
11051102
// Only one Workforce Identity Federation IdP can be configured per MongoDB resource
11061103
// +kubebuilder:validation:Required
11071104
AuthorizationMethod OIDCAuthorizationMethod `json:"authorizationMethod"`

config/crd/bases/mongodb.com_mongodb.yaml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1535,8 +1535,8 @@ spec:
15351535
type: string
15361536
authorizationMethod:
15371537
description: |-
1538-
Configure single-sign-on for human user access to Ops Manager deployments with Workforce Identity Federation.
1539-
For programmatic, application access to Ops Manager deployments use Workload Identity Federation.
1538+
Configure single-sign-on for human user access to deployments with Workforce Identity Federation.
1539+
For programmatic, application access to deployments use Workload Identity Federation.
15401540
Only one Workforce Identity Federation IdP can be configured per MongoDB resource
15411541
enum:
15421542
- WorkforceIdentityFederation
@@ -1558,8 +1558,7 @@ spec:
15581558
type: string
15591559
configurationName:
15601560
description: |-
1561-
Unique label that identifies this configuration. This label is visible to your Ops Manager users and is used when
1562-
creating users and roles for authorization. It is case-sensitive and can only contain the following characters:
1561+
Unique label that identifies this configuration. It is case-sensitive and can only contain the following characters:
15631562
- alphanumeric characters (combination of a to z and 0 to 9)
15641563
- hyphens (-)
15651564
- underscores (_)
@@ -1568,12 +1567,11 @@ spec:
15681567
groupsClaim:
15691568
description: |-
15701569
The identifier of the claim that includes the principal's IdP user group membership information.
1571-
Accept the default value unless your IdP uses a different claim, or you need a custom claim.
15721570
Required when selected GroupMembership as the authorization type, ignored otherwise
15731571
type: string
15741572
issuerURI:
15751573
description: |-
1576-
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Provider
1574+
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Connect Provider
15771575
Configuration Document, which should be available in the /.wellknown/open-id-configuration endpoint.
15781576
For MongoDB 7.0, 7.3, and 8.0+, the combination of issuerURI and audience must be unique across OIDC provider configurations.
15791577
For other MongoDB versions, the issuerURI itself must be unique.

config/crd/bases/mongodb.com_mongodbmulticluster.yaml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -795,8 +795,8 @@ spec:
795795
type: string
796796
authorizationMethod:
797797
description: |-
798-
Configure single-sign-on for human user access to Ops Manager deployments with Workforce Identity Federation.
799-
For programmatic, application access to Ops Manager deployments use Workload Identity Federation.
798+
Configure single-sign-on for human user access to deployments with Workforce Identity Federation.
799+
For programmatic, application access to deployments use Workload Identity Federation.
800800
Only one Workforce Identity Federation IdP can be configured per MongoDB resource
801801
enum:
802802
- WorkforceIdentityFederation
@@ -818,8 +818,7 @@ spec:
818818
type: string
819819
configurationName:
820820
description: |-
821-
Unique label that identifies this configuration. This label is visible to your Ops Manager users and is used when
822-
creating users and roles for authorization. It is case-sensitive and can only contain the following characters:
821+
Unique label that identifies this configuration. It is case-sensitive and can only contain the following characters:
823822
- alphanumeric characters (combination of a to z and 0 to 9)
824823
- hyphens (-)
825824
- underscores (_)
@@ -828,12 +827,11 @@ spec:
828827
groupsClaim:
829828
description: |-
830829
The identifier of the claim that includes the principal's IdP user group membership information.
831-
Accept the default value unless your IdP uses a different claim, or you need a custom claim.
832830
Required when selected GroupMembership as the authorization type, ignored otherwise
833831
type: string
834832
issuerURI:
835833
description: |-
836-
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Provider
834+
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Connect Provider
837835
Configuration Document, which should be available in the /.wellknown/open-id-configuration endpoint.
838836
For MongoDB 7.0, 7.3, and 8.0+, the combination of issuerURI and audience must be unique across OIDC provider configurations.
839837
For other MongoDB versions, the issuerURI itself must be unique.

config/crd/bases/mongodb.com_opsmanagers.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -857,8 +857,8 @@ spec:
857857
type: string
858858
authorizationMethod:
859859
description: |-
860-
Configure single-sign-on for human user access to Ops Manager deployments with Workforce Identity Federation.
861-
For programmatic, application access to Ops Manager deployments use Workload Identity Federation.
860+
Configure single-sign-on for human user access to deployments with Workforce Identity Federation.
861+
For programmatic, application access to deployments use Workload Identity Federation.
862862
Only one Workforce Identity Federation IdP can be configured per MongoDB resource
863863
enum:
864864
- WorkforceIdentityFederation
@@ -880,8 +880,7 @@ spec:
880880
type: string
881881
configurationName:
882882
description: |-
883-
Unique label that identifies this configuration. This label is visible to your Ops Manager users and is used when
884-
creating users and roles for authorization. It is case-sensitive and can only contain the following characters:
883+
Unique label that identifies this configuration. It is case-sensitive and can only contain the following characters:
885884
- alphanumeric characters (combination of a to z and 0 to 9)
886885
- hyphens (-)
887886
- underscores (_)
@@ -890,13 +889,14 @@ spec:
890889
groupsClaim:
891890
description: |-
892891
The identifier of the claim that includes the principal's IdP user group membership information.
893-
Accept the default value unless your IdP uses a different claim, or you need a custom claim.
894892
Required when selected GroupMembership as the authorization type, ignored otherwise
895893
type: string
896894
issuerURI:
897895
description: |-
898-
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Provider
896+
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Connect Provider
899897
Configuration Document, which should be available in the /.wellknown/open-id-configuration endpoint.
898+
For MongoDB 7.0, 7.3, and 8.0+, the combination of issuerURI and audience must be unique across OIDC provider configurations.
899+
For other MongoDB versions, the issuerURI itself must be unique.
900900
type: string
901901
requestedScopes:
902902
description: |-

helm_chart/crds/mongodb.com_mongodb.yaml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1535,8 +1535,8 @@ spec:
15351535
type: string
15361536
authorizationMethod:
15371537
description: |-
1538-
Configure single-sign-on for human user access to Ops Manager deployments with Workforce Identity Federation.
1539-
For programmatic, application access to Ops Manager deployments use Workload Identity Federation.
1538+
Configure single-sign-on for human user access to deployments with Workforce Identity Federation.
1539+
For programmatic, application access to deployments use Workload Identity Federation.
15401540
Only one Workforce Identity Federation IdP can be configured per MongoDB resource
15411541
enum:
15421542
- WorkforceIdentityFederation
@@ -1558,8 +1558,7 @@ spec:
15581558
type: string
15591559
configurationName:
15601560
description: |-
1561-
Unique label that identifies this configuration. This label is visible to your Ops Manager users and is used when
1562-
creating users and roles for authorization. It is case-sensitive and can only contain the following characters:
1561+
Unique label that identifies this configuration. It is case-sensitive and can only contain the following characters:
15631562
- alphanumeric characters (combination of a to z and 0 to 9)
15641563
- hyphens (-)
15651564
- underscores (_)
@@ -1568,12 +1567,11 @@ spec:
15681567
groupsClaim:
15691568
description: |-
15701569
The identifier of the claim that includes the principal's IdP user group membership information.
1571-
Accept the default value unless your IdP uses a different claim, or you need a custom claim.
15721570
Required when selected GroupMembership as the authorization type, ignored otherwise
15731571
type: string
15741572
issuerURI:
15751573
description: |-
1576-
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Provider
1574+
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Connect Provider
15771575
Configuration Document, which should be available in the /.wellknown/open-id-configuration endpoint.
15781576
For MongoDB 7.0, 7.3, and 8.0+, the combination of issuerURI and audience must be unique across OIDC provider configurations.
15791577
For other MongoDB versions, the issuerURI itself must be unique.

helm_chart/crds/mongodb.com_mongodbmulticluster.yaml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -795,8 +795,8 @@ spec:
795795
type: string
796796
authorizationMethod:
797797
description: |-
798-
Configure single-sign-on for human user access to Ops Manager deployments with Workforce Identity Federation.
799-
For programmatic, application access to Ops Manager deployments use Workload Identity Federation.
798+
Configure single-sign-on for human user access to deployments with Workforce Identity Federation.
799+
For programmatic, application access to deployments use Workload Identity Federation.
800800
Only one Workforce Identity Federation IdP can be configured per MongoDB resource
801801
enum:
802802
- WorkforceIdentityFederation
@@ -818,8 +818,7 @@ spec:
818818
type: string
819819
configurationName:
820820
description: |-
821-
Unique label that identifies this configuration. This label is visible to your Ops Manager users and is used when
822-
creating users and roles for authorization. It is case-sensitive and can only contain the following characters:
821+
Unique label that identifies this configuration. It is case-sensitive and can only contain the following characters:
823822
- alphanumeric characters (combination of a to z and 0 to 9)
824823
- hyphens (-)
825824
- underscores (_)
@@ -828,12 +827,11 @@ spec:
828827
groupsClaim:
829828
description: |-
830829
The identifier of the claim that includes the principal's IdP user group membership information.
831-
Accept the default value unless your IdP uses a different claim, or you need a custom claim.
832830
Required when selected GroupMembership as the authorization type, ignored otherwise
833831
type: string
834832
issuerURI:
835833
description: |-
836-
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Provider
834+
Issuer value provided by your registered IdP application. Using this URI, MongoDB finds an OpenID Connect Provider
837835
Configuration Document, which should be available in the /.wellknown/open-id-configuration endpoint.
838836
For MongoDB 7.0, 7.3, and 8.0+, the combination of issuerURI and audience must be unique across OIDC provider configurations.
839837
For other MongoDB versions, the issuerURI itself must be unique.

0 commit comments

Comments
 (0)