From 863d37270560eabff5c64df96a3b3639e2ebaae9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fatih=20T=C3=BCrken?= Date: Thu, 8 Aug 2024 15:36:39 +0300 Subject: [PATCH] Add description to consoleAccess field for MQ User MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fatih Türken --- apis/mq/v1alpha1/zz_user_types.go | 5 ++++- config/mq/config.go | 5 +++++ package/crds/mq.aws.upbound.io_users.yaml | 8 +++++++- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/apis/mq/v1alpha1/zz_user_types.go b/apis/mq/v1alpha1/zz_user_types.go index d3af8bcf7c..8b647ea38b 100755 --- a/apis/mq/v1alpha1/zz_user_types.go +++ b/apis/mq/v1alpha1/zz_user_types.go @@ -26,6 +26,7 @@ type UserInitParameters struct { // +kubebuilder:validation:Optional BrokerIDSelector *v1.Selector `json:"brokerIdSelector,omitempty" tf:"-"` + // Setting consoleAccess will result in an update loop till the MQ Broker to which this user belongs is restarted. ConsoleAccess *bool `json:"consoleAccess,omitempty" tf:"console_access,omitempty"` Groups []*string `json:"groups,omitempty" tf:"groups,omitempty"` @@ -40,6 +41,7 @@ type UserInitParameters struct { type UserObservation struct { BrokerID *string `json:"brokerId,omitempty" tf:"broker_id,omitempty"` + // Setting consoleAccess will result in an update loop till the MQ Broker to which this user belongs is restarted. ConsoleAccess *bool `json:"consoleAccess,omitempty" tf:"console_access,omitempty"` Groups []*string `json:"groups,omitempty" tf:"groups,omitempty"` @@ -65,6 +67,7 @@ type UserParameters struct { // +kubebuilder:validation:Optional BrokerIDSelector *v1.Selector `json:"brokerIdSelector,omitempty" tf:"-"` + // Setting consoleAccess will result in an update loop till the MQ Broker to which this user belongs is restarted. // +kubebuilder:validation:Optional ConsoleAccess *bool `json:"consoleAccess,omitempty" tf:"console_access,omitempty"` @@ -113,7 +116,7 @@ type UserStatus struct { // +kubebuilder:subresource:status // +kubebuilder:storageversion -// User is the Schema for the Users API. +// User is the Schema for the Users API. // +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" // +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" // +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" diff --git a/config/mq/config.go b/config/mq/config.go index 49642bf360..21265723d4 100644 --- a/config/mq/config.go +++ b/config/mq/config.go @@ -8,6 +8,7 @@ import ( "fmt" "github.com/crossplane/upjet/pkg/config" + "github.com/crossplane/upjet/pkg/registry" ) // Configure adds configurations for the mq group. @@ -68,5 +69,9 @@ func Configure(p *config.Provider) { TerraformName: "aws_mq_broker", } r.Version = "v1alpha1" + r.MetaResource = ®istry.Resource{ + ArgumentDocs: make(map[string]string), + } + r.MetaResource.ArgumentDocs["console_access"] = `- (Optional) Setting consoleAccess will result in an update loop till the MQ Broker to which this user belongs is restarted.` }) } diff --git a/package/crds/mq.aws.upbound.io_users.yaml b/package/crds/mq.aws.upbound.io_users.yaml index f80126e009..c087e3561f 100644 --- a/package/crds/mq.aws.upbound.io_users.yaml +++ b/package/crds/mq.aws.upbound.io_users.yaml @@ -34,7 +34,7 @@ spec: name: v1alpha1 schema: openAPIV3Schema: - description: User is the Schema for the Users API. + description: User is the Schema for the Users API. properties: apiVersion: description: |- @@ -149,6 +149,8 @@ spec: type: object type: object consoleAccess: + description: Setting consoleAccess will result in an update loop + till the MQ Broker to which this user belongs is restarted. type: boolean groups: items: @@ -273,6 +275,8 @@ spec: type: object type: object consoleAccess: + description: Setting consoleAccess will result in an update loop + till the MQ Broker to which this user belongs is restarted. type: boolean groups: items: @@ -486,6 +490,8 @@ spec: brokerId: type: string consoleAccess: + description: Setting consoleAccess will result in an update loop + till the MQ Broker to which this user belongs is restarted. type: boolean groups: items: