Skip to content

Commit

Permalink
chore(cryostat3): various cleanups (#808)
Browse files Browse the repository at this point in the history
  • Loading branch information
@andrewazores
andrewazores authored May 8, 2024
1 parent 6e7e17e commit 0a3021f
Show file tree
Hide file tree
Showing 16 changed files with 588 additions and 712 deletions.
8 changes: 0 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,6 @@ at the URL provided by:
```
kubectl get cryostat -o jsonpath='{$.items[0].status.applicationUrl}'
```
The Grafana credentials can be obtained with:
```shell
CRYOSTAT_NAME=$(kubectl get cryostat -o jsonpath='{$.items[0].metadata.name}')
# Username
kubectl get secret ${CRYOSTAT_NAME}-grafana-basic -o jsonpath='{$.data.GF_SECURITY_ADMIN_USER}' | base64 -d
# Password
kubectl get secret ${CRYOSTAT_NAME}-grafana-basic -o jsonpath='{$.data.GF_SECURITY_ADMIN_PASSWORD}' | base64 -d
```
The JMX authentication credentials for Cryostat itself can be obtained with:
```shell
CRYOSTAT_NAME=$(kubectl get cryostat -o jsonpath='{$.items[0].metadata.name}')
Expand Down
56 changes: 14 additions & 42 deletions api/v1beta1/cryostat_conversion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,18 @@ func convertSpecTo(src *CryostatSpec, dst *operatorv1beta2.CryostatSpec) {
dst.ServiceOptions = convertServiceOptionsTo(src.ServiceOptions)
dst.NetworkOptions = convertNetworkOptionsTo(src.NetworkOptions)
dst.ReportOptions = convertReportOptionsTo(src.ReportOptions)
dst.JmxCacheOptions = convertJmxCacheOptionsTo(src.JmxCacheOptions)
dst.TargetConnectionCacheOptions = convertJmxCacheOptionsTo(src.JmxCacheOptions)
dst.Resources = convertResourceOptionsTo(src.Resources)
dst.AuthProperties = convertAuthPropertiesTo(src.AuthProperties)
dst.SecurityOptions = convertSecurityOptionsTo(src.SecurityOptions)
dst.SchedulingOptions = convertSchedulingOptionsTo(src.SchedulingOptions)
dst.TargetDiscoveryOptions = convertTargetDiscoveryTo(src.TargetDiscoveryOptions)
dst.JmxCredentialsDatabaseOptions = convertDatabaseOptionsTo(src.JmxCredentialsDatabaseOptions)
dst.DatabaseOptions = convertDatabaseOptionsTo(src.JmxCredentialsDatabaseOptions)
dst.OperandMetadata = convertOperandMetadataTo(src.OperandMetadata)
}

func convertStatusTo(src *CryostatStatus, dst *operatorv1beta2.CryostatStatus) {
dst.ApplicationURL = src.ApplicationURL
dst.Conditions = src.Conditions
dst.GrafanaSecret = src.GrafanaSecret
}

func convertCertSecretsTo(srcCerts []CertificateSecret) []operatorv1beta2.CertificateSecret {
Expand Down Expand Up @@ -214,10 +212,10 @@ func convertSchedulingOptionsTo(srcOpts *SchedulingConfiguration) *operatorv1bet
return dstOpts
}

func convertJmxCacheOptionsTo(srcOpts *JmxCacheOptions) *operatorv1beta2.JmxCacheOptions {
var dstOpts *operatorv1beta2.JmxCacheOptions
func convertJmxCacheOptionsTo(srcOpts *JmxCacheOptions) *operatorv1beta2.TargetConnectionCacheOptions {
var dstOpts *operatorv1beta2.TargetConnectionCacheOptions
if srcOpts != nil {
dstOpts = &operatorv1beta2.JmxCacheOptions{
dstOpts = &operatorv1beta2.TargetConnectionCacheOptions{
TargetCacheSize: srcOpts.TargetCacheSize,
TargetCacheTTL: srcOpts.TargetCacheTTL,
}
Expand All @@ -237,18 +235,6 @@ func convertResourceOptionsTo(srcOpts *ResourceConfigList) *operatorv1beta2.Reso
return dstOpts
}

func convertAuthPropertiesTo(srcProps *AuthorizationProperties) *operatorv1beta2.AuthorizationProperties {
var dstProps *operatorv1beta2.AuthorizationProperties
if srcProps != nil {
dstProps = &operatorv1beta2.AuthorizationProperties{
ClusterRoleName: srcProps.ClusterRoleName,
ConfigMapName: srcProps.ConfigMapName,
Filename: srcProps.Filename,
}
}
return dstProps
}

func convertSecurityOptionsTo(srcOpts *SecurityOptions) *operatorv1beta2.SecurityOptions {
var dstOpts *operatorv1beta2.SecurityOptions
if srcOpts != nil {
Expand Down Expand Up @@ -276,11 +262,11 @@ func convertTargetDiscoveryTo(srcOpts *TargetDiscoveryOptions) *operatorv1beta2.
return dstOpts
}

func convertDatabaseOptionsTo(srcOpts *JmxCredentialsDatabaseOptions) *operatorv1beta2.JmxCredentialsDatabaseOptions {
var dstOpts *operatorv1beta2.JmxCredentialsDatabaseOptions
func convertDatabaseOptionsTo(srcOpts *JmxCredentialsDatabaseOptions) *operatorv1beta2.DatabaseOptions {
var dstOpts *operatorv1beta2.DatabaseOptions
if srcOpts != nil {
dstOpts = &operatorv1beta2.JmxCredentialsDatabaseOptions{
DatabaseSecretName: srcOpts.DatabaseSecretName,
dstOpts = &operatorv1beta2.DatabaseOptions{
SecretName: srcOpts.DatabaseSecretName,
}
}
return dstOpts
Expand Down Expand Up @@ -332,20 +318,18 @@ func convertSpecFrom(src *operatorv1beta2.CryostatSpec, dst *CryostatSpec) {
dst.ServiceOptions = convertServiceOptionsFrom(src.ServiceOptions)
dst.NetworkOptions = convertNetworkOptionsFrom(src.NetworkOptions)
dst.ReportOptions = convertReportOptionsFrom(src.ReportOptions)
dst.JmxCacheOptions = convertJmxCacheOptionsFrom(src.JmxCacheOptions)
dst.JmxCacheOptions = convertJmxCacheOptionsFrom(src.TargetConnectionCacheOptions)
dst.Resources = convertResourceOptionsFrom(src.Resources)
dst.AuthProperties = convertAuthPropertiesFrom(src.AuthProperties)
dst.SecurityOptions = convertSecurityOptionsFrom(src.SecurityOptions)
dst.SchedulingOptions = convertSchedulingOptionsFrom(src.SchedulingOptions)
dst.TargetDiscoveryOptions = convertTargetDiscoveryFrom(src.TargetDiscoveryOptions)
dst.JmxCredentialsDatabaseOptions = convertDatabaseOptionsFrom(src.JmxCredentialsDatabaseOptions)
dst.JmxCredentialsDatabaseOptions = convertDatabaseOptionsFrom(src.DatabaseOptions)
dst.OperandMetadata = convertOperandMetadataFrom(src.OperandMetadata)
}

func convertStatusFrom(src *operatorv1beta2.CryostatStatus, dst *CryostatStatus) {
dst.ApplicationURL = src.ApplicationURL
dst.Conditions = src.Conditions
dst.GrafanaSecret = src.GrafanaSecret
}

func convertCertSecretsFrom(srcCerts []operatorv1beta2.CertificateSecret) []CertificateSecret {
Expand Down Expand Up @@ -497,7 +481,7 @@ func convertSchedulingOptionsFrom(srcOpts *operatorv1beta2.SchedulingConfigurati
return dstOpts
}

func convertJmxCacheOptionsFrom(srcOpts *operatorv1beta2.JmxCacheOptions) *JmxCacheOptions {
func convertJmxCacheOptionsFrom(srcOpts *operatorv1beta2.TargetConnectionCacheOptions) *JmxCacheOptions {
var dstOpts *JmxCacheOptions
if srcOpts != nil {
dstOpts = &JmxCacheOptions{
Expand All @@ -520,18 +504,6 @@ func convertResourceOptionsFrom(srcOpts *operatorv1beta2.ResourceConfigList) *Re
return dstOpts
}

func convertAuthPropertiesFrom(srcProps *operatorv1beta2.AuthorizationProperties) *AuthorizationProperties {
var dstProps *AuthorizationProperties
if srcProps != nil {
dstProps = &AuthorizationProperties{
ClusterRoleName: srcProps.ClusterRoleName,
ConfigMapName: srcProps.ConfigMapName,
Filename: srcProps.Filename,
}
}
return dstProps
}

func convertSecurityOptionsFrom(srcOpts *operatorv1beta2.SecurityOptions) *SecurityOptions {
var dstOpts *SecurityOptions
if srcOpts != nil {
Expand Down Expand Up @@ -559,11 +531,11 @@ func convertTargetDiscoveryFrom(srcOpts *operatorv1beta2.TargetDiscoveryOptions)
return dstOpts
}

func convertDatabaseOptionsFrom(srcOpts *operatorv1beta2.JmxCredentialsDatabaseOptions) *JmxCredentialsDatabaseOptions {
func convertDatabaseOptionsFrom(srcOpts *operatorv1beta2.DatabaseOptions) *JmxCredentialsDatabaseOptions {
var dstOpts *JmxCredentialsDatabaseOptions
if srcOpts != nil {
dstOpts = &JmxCredentialsDatabaseOptions{
DatabaseSecretName: srcOpts.DatabaseSecretName,
DatabaseSecretName: srcOpts.SecretName,
}
}
return dstOpts
Expand Down
53 changes: 27 additions & 26 deletions api/v1beta2/cryostat_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ type CryostatSpec struct {
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,order=3,displayName="Enable cert-manager Integration",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:booleanSwitch"}
EnableCertManager *bool `json:"enableCertManager"`
// Options to customize the storage for Flight Recordings and Templates.
// Options to customize the storage provisioned for the database and object storage.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec
StorageOptions *StorageConfiguration `json:"storageOptions,omitempty"`
// Options to customize the services created for the Cryostat application and Grafana dashboard.
// Options to customize the services created for the Cryostat application.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec
ServiceOptions *ServiceConfigList `json:"serviceOptions,omitempty"`
Expand All @@ -62,10 +62,10 @@ type CryostatSpec struct {
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec
ReportOptions *ReportConfiguration `json:"reportOptions,omitempty"`
// Options to customize the JMX target connections cache for the Cryostat application.
// Options to customize the target connections cache for the Cryostat application.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="JMX Connections Cache Options"
JmxCacheOptions *JmxCacheOptions `json:"jmxCacheOptions,omitempty"`
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Target Connection Cache Options"
TargetConnectionCacheOptions *TargetConnectionCacheOptions `json:"targetConnectionCacheOptions,omitempty"`
// Resource requirements for the Cryostat deployment.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec
Expand All @@ -74,10 +74,6 @@ type CryostatSpec struct {
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Authorization Options",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced"}
AuthorizationOptions *AuthorizationOptions `json:"authorizationOptions,omitempty"`
// Override default authorization properties for Cryostat on OpenShift.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Authorization Properties",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced"}
AuthProperties *AuthorizationProperties `json:"authProperties,omitempty"`
// Options to configure the Security Contexts for the Cryostat application.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced"}
Expand All @@ -90,10 +86,10 @@ type CryostatSpec struct {
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec
TargetDiscoveryOptions *TargetDiscoveryOptions `json:"targetDiscoveryOptions,omitempty"`
// Options to configure the Cryostat application's credentials database.
// Options to configure the Cryostat application's database.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Credentials Database Options"
JmxCredentialsDatabaseOptions *JmxCredentialsDatabaseOptions `json:"jmxCredentialsDatabaseOptions,omitempty"`
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Database Options"
DatabaseOptions *DatabaseOptions `json:"databaseOptions,omitempty"`
// Options to configure the Cryostat deployments and pods metadata
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Operand metadata"
Expand Down Expand Up @@ -127,7 +123,7 @@ type ResourceConfigList struct {
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements"}
AuthProxyResources corev1.ResourceRequirements `json:"authProxyResources,omitempty"`
// Resource requirements for the Cryostat application. If specifying a memory limit, at least 768MiB is recommended.
// Resource requirements for the Cryostat application. If specifying a memory limit, at least 384MiB is recommended.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements"}
CoreResources corev1.ResourceRequirements `json:"coreResources,omitempty"`
Expand All @@ -139,6 +135,14 @@ type ResourceConfigList struct {
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements"}
GrafanaResources corev1.ResourceRequirements `json:"grafanaResources,omitempty"`
// Resource requirements for the database container.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements"}
DatabaseResources corev1.ResourceRequirements `json:"databaseResources,omitempty"`
// Resource requirements for the object storage container.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:resourceRequirements"}
ObjectStorageResources corev1.ResourceRequirements `json:"objectStorageResources,omitempty"`
}

// CryostatStatus defines the observed state of Cryostat.
Expand All @@ -152,10 +156,6 @@ type CryostatStatus struct {
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=status,displayName="Cryostat Conditions",xDescriptors={"urn:alm:descriptor:io.kubernetes.conditions"}
Conditions []metav1.Condition `json:"conditions,omitempty"`
// Name of the Secret containing the generated Grafana credentials.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=status,order=2,xDescriptors={"urn:alm:descriptor:io.kubernetes:Secret"}
GrafanaSecret string `json:"grafanaSecret,omitempty"`
// Address of the deployed Cryostat web application.
// +operator-sdk:csv:customresourcedefinitions:type=status,order=1,xDescriptors={"urn:alm:descriptor:org.w3:link"}
ApplicationURL string `json:"applicationUrl"`
Expand Down Expand Up @@ -405,15 +405,15 @@ type EmptyDirConfig struct {
SizeLimit string `json:"sizeLimit,omitempty"`
}

// JmxCacheConfig provides customization for the JMX target connections
// TargetConnectionCacheOptions provides customization for the target connections
// cache for the Cryostat application.
type JmxCacheOptions struct {
// The maximum number of JMX connections to cache. Use `-1` for an unlimited cache size (TTL expiration only). Defaults to `-1`.
type TargetConnectionCacheOptions struct {
// The maximum number of target connections to cache. Use `-1` for an unlimited cache size (TTL expiration only). Defaults to `-1`.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:number"}
// +kubebuilder:validation:Minimum=-1
TargetCacheSize int32 `json:"targetCacheSize,omitempty"`
// The time to live (in seconds) for cached JMX connections. Defaults to `10`.
// The time to live (in seconds) for cached target connections. Defaults to `10`.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:number"}
// +kubebuilder:validation:Minimum=1
Expand All @@ -432,7 +432,6 @@ type JmxCacheOptions struct {
// to deploy the Cryostat application.
// +operator-sdk:csv:customresourcedefinitions:resources={{Deployment,v1},{Ingress,v1},{PersistentVolumeClaim,v1},{Secret,v1},{Service,v1},{Route,v1},{ConsoleLink,v1}}
// +kubebuilder:printcolumn:name="Application URL",type=string,JSONPath=`.status.applicationUrl`
// +kubebuilder:printcolumn:name="Grafana Secret",type=string,JSONPath=`.status.grafanaSecret`
type Cryostat struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Expand Down Expand Up @@ -611,10 +610,12 @@ type TargetDiscoveryOptions struct {
DiscoveryPortNumbers []int32 `json:"discoveryPortNumbers,omitempty"`
}

// JmxCredentialsDatabaseOptions provides configuration options to the Cryostat application's credentials database.
type JmxCredentialsDatabaseOptions struct {
// Name of the secret containing the password to encrypt credentials database.
// DatabaseOptions provides configuration options to the Cryostat application's database.
type DatabaseOptions struct {
// Name of the secret containing database keys. This secret must contain a CONNECTION_KEY secret which is the
// database connection password, and an ENCRYPTION_KEY secret which is the key used to encrypt sensitive data
// stored within the database, such as the target credentials keyring.
// +optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:io.kubernetes:Secret"}
DatabaseSecretName *string `json:"databaseSecretName,omitempty"`
SecretName *string `json:"secretName,omitempty"`
}
Loading

0 comments on commit 0a3021f

Please sign in to comment.