From 8481d190557c15d241d0090cdb3d6a11aee86a8e Mon Sep 17 00:00:00 2001 From: Thuan Vo Date: Tue, 2 May 2023 11:33:12 -0400 Subject: [PATCH] fix(crd): remove mentions of JMX in credential database Signed-off-by: Thuan Vo --- api/v1beta1/cryostat_types.go | 8 ++++---- .../cryostat-operator.clusterserviceversion.yaml | 16 +++++++--------- .../operator.cryostat.io_clustercryostats.yaml | 4 ++-- .../operator.cryostat.io_cryostats.yaml | 4 ++-- .../operator.cryostat.io_clustercryostats.yaml | 4 ++-- .../bases/operator.cryostat.io_cryostats.yaml | 4 ++-- .../cryostat-operator.clusterserviceversion.yaml | 14 ++++++-------- internal/controllers/secrets.go | 4 ++-- 8 files changed, 27 insertions(+), 31 deletions(-) diff --git a/api/v1beta1/cryostat_types.go b/api/v1beta1/cryostat_types.go index f862ff0e..fe562481 100644 --- a/api/v1beta1/cryostat_types.go +++ b/api/v1beta1/cryostat_types.go @@ -106,9 +106,9 @@ type CryostatSpec struct { // +optional // +operator-sdk:csv:customresourcedefinitions:type=spec TargetDiscoveryOptions *TargetDiscoveryOptions `json:"targetDiscoveryOptions,omitempty"` - // Options to configure the Cryostat application's JMX credentials database. + // Options to configure the Cryostat application's credentials database. // +optional - // +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="JMX Credentials Database Options" + // +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Credentials Database Options" JmxCredentialsDatabaseOptions *JmxCredentialsDatabaseOptions `json:"jmxCredentialsDatabaseOptions,omitempty"` } @@ -522,9 +522,9 @@ type TargetDiscoveryOptions struct { BuiltInDiscoveryDisabled bool `json:"builtInDiscoveryDisabled,omitempty"` } -// JmxCredentialsDatabaseOptions provides configuration options to the Cryostat application's JMX credentials database. +// JmxCredentialsDatabaseOptions provides configuration options to the Cryostat application's credentials database. type JmxCredentialsDatabaseOptions struct { - // Name of the secret containing the password to encrypt JMX credentials database. + // Name of the secret containing the password to encrypt credentials database. // +optional // +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:io.kubernetes:Secret"} DatabaseSecretName *string `json:"databaseSecretName,omitempty"` diff --git a/bundle/manifests/cryostat-operator.clusterserviceversion.yaml b/bundle/manifests/cryostat-operator.clusterserviceversion.yaml index 3085eff7..bc88db1b 100644 --- a/bundle/manifests/cryostat-operator.clusterserviceversion.yaml +++ b/bundle/manifests/cryostat-operator.clusterserviceversion.yaml @@ -54,7 +54,7 @@ metadata: capabilities: Seamless Upgrades categories: Monitoring, Developer Tools containerImage: quay.io/cryostat/cryostat-operator:2.4.0-dev - createdAt: "2023-05-01T14:54:37Z" + createdAt: "2023-05-02T15:53:41Z" description: JVM monitoring and profiling tool operatorframework.io/initialization-resource: |- { @@ -182,11 +182,10 @@ spec: path: jmxCacheOptions.targetCacheTTL x-descriptors: - urn:alm:descriptor:com.tectonic.ui:number - - description: Options to configure the Cryostat application's JMX credentials - database. - displayName: JMX Credentials Database Options + - description: Options to configure the Cryostat application's credentials database. + displayName: Credentials Database Options path: jmxCredentialsDatabaseOptions - - description: Name of the secret containing the password to encrypt JMX credentials + - description: Name of the secret containing the password to encrypt credentials database. displayName: Database Secret Name path: jmxCredentialsDatabaseOptions.databaseSecretName @@ -566,11 +565,10 @@ spec: path: jmxCacheOptions.targetCacheTTL x-descriptors: - urn:alm:descriptor:com.tectonic.ui:number - - description: Options to configure the Cryostat application's JMX credentials - database. - displayName: JMX Credentials Database Options + - description: Options to configure the Cryostat application's credentials database. + displayName: Credentials Database Options path: jmxCredentialsDatabaseOptions - - description: Name of the secret containing the password to encrypt JMX credentials + - description: Name of the secret containing the password to encrypt credentials database. displayName: Database Secret Name path: jmxCredentialsDatabaseOptions.databaseSecretName diff --git a/bundle/manifests/operator.cryostat.io_clustercryostats.yaml b/bundle/manifests/operator.cryostat.io_clustercryostats.yaml index 0e58939a..de81135e 100644 --- a/bundle/manifests/operator.cryostat.io_clustercryostats.yaml +++ b/bundle/manifests/operator.cryostat.io_clustercryostats.yaml @@ -112,12 +112,12 @@ spec: type: integer type: object jmxCredentialsDatabaseOptions: - description: Options to configure the Cryostat application's JMX credentials + description: Options to configure the Cryostat application's credentials database. properties: databaseSecretName: description: Name of the secret containing the password to encrypt - JMX credentials database. + credentials database. type: string type: object maxWsConnections: diff --git a/bundle/manifests/operator.cryostat.io_cryostats.yaml b/bundle/manifests/operator.cryostat.io_cryostats.yaml index eb467d99..9bdfb650 100644 --- a/bundle/manifests/operator.cryostat.io_cryostats.yaml +++ b/bundle/manifests/operator.cryostat.io_cryostats.yaml @@ -108,12 +108,12 @@ spec: type: integer type: object jmxCredentialsDatabaseOptions: - description: Options to configure the Cryostat application's JMX credentials + description: Options to configure the Cryostat application's credentials database. properties: databaseSecretName: description: Name of the secret containing the password to encrypt - JMX credentials database. + credentials database. type: string type: object maxWsConnections: diff --git a/config/crd/bases/operator.cryostat.io_clustercryostats.yaml b/config/crd/bases/operator.cryostat.io_clustercryostats.yaml index 6e8273bb..a0b52d79 100644 --- a/config/crd/bases/operator.cryostat.io_clustercryostats.yaml +++ b/config/crd/bases/operator.cryostat.io_clustercryostats.yaml @@ -113,12 +113,12 @@ spec: type: integer type: object jmxCredentialsDatabaseOptions: - description: Options to configure the Cryostat application's JMX credentials + description: Options to configure the Cryostat application's credentials database. properties: databaseSecretName: description: Name of the secret containing the password to encrypt - JMX credentials database. + credentials database. type: string type: object maxWsConnections: diff --git a/config/crd/bases/operator.cryostat.io_cryostats.yaml b/config/crd/bases/operator.cryostat.io_cryostats.yaml index 091bc0b8..2fca14f9 100644 --- a/config/crd/bases/operator.cryostat.io_cryostats.yaml +++ b/config/crd/bases/operator.cryostat.io_cryostats.yaml @@ -109,12 +109,12 @@ spec: type: integer type: object jmxCredentialsDatabaseOptions: - description: Options to configure the Cryostat application's JMX credentials + description: Options to configure the Cryostat application's credentials database. properties: databaseSecretName: description: Name of the secret containing the password to encrypt - JMX credentials database. + credentials database. type: string type: object maxWsConnections: diff --git a/config/manifests/bases/cryostat-operator.clusterserviceversion.yaml b/config/manifests/bases/cryostat-operator.clusterserviceversion.yaml index 09553ff7..82bb4acb 100644 --- a/config/manifests/bases/cryostat-operator.clusterserviceversion.yaml +++ b/config/manifests/bases/cryostat-operator.clusterserviceversion.yaml @@ -133,11 +133,10 @@ spec: path: jmxCacheOptions.targetCacheTTL x-descriptors: - urn:alm:descriptor:com.tectonic.ui:number - - description: Options to configure the Cryostat application's JMX credentials - database. - displayName: JMX Credentials Database Options + - description: Options to configure the Cryostat application's credentials database. + displayName: Credentials Database Options path: jmxCredentialsDatabaseOptions - - description: Name of the secret containing the password to encrypt JMX credentials + - description: Name of the secret containing the password to encrypt credentials database. displayName: Database Secret Name path: jmxCredentialsDatabaseOptions.databaseSecretName @@ -505,11 +504,10 @@ spec: path: jmxCacheOptions.targetCacheTTL x-descriptors: - urn:alm:descriptor:com.tectonic.ui:number - - description: Options to configure the Cryostat application's JMX credentials - database. - displayName: JMX Credentials Database Options + - description: Options to configure the Cryostat application's credentials database. + displayName: Credentials Database Options path: jmxCredentialsDatabaseOptions - - description: Name of the secret containing the password to encrypt JMX credentials + - description: Name of the secret containing the password to encrypt credentials database. displayName: Database Secret Name path: jmxCredentialsDatabaseOptions.databaseSecretName diff --git a/internal/controllers/secrets.go b/internal/controllers/secrets.go index ed0ae288..b1b5897b 100644 --- a/internal/controllers/secrets.go +++ b/internal/controllers/secrets.go @@ -129,10 +129,10 @@ func (r *Reconciler) reconcileJMXSecret(ctx context.Context, cr *model.CryostatI } // databaseSecretNameSuffix is the suffix to be appended to the name of a -// Cryostat CR to name its JMX credentials database secret +// Cryostat CR to name its credentials database secret const databaseSecretNameSuffix = "-jmx-credentials-db" -// dbSecretUserKey indexes the password within the Cryostat JMX credentials database Secret +// dbSecretUserKey indexes the password within the Cryostat credentials database Secret const databaseSecretPassKey = "CRYOSTAT_JMX_CREDENTIALS_DB_PASSWORD" func (r *Reconciler) reconcileDatabaseSecret(ctx context.Context, cr *model.CryostatInstance) error {