# Verrazzano v1beta1

Packages:

## install.verrazzano.io/v1beta1

Resource Types:

### Verrazzano

Verrazzano specifies the Verrazzano API.

Field Description
apiVersion
string
 install.verrazzano.io/v1beta1 
kind
string
Verrazzano
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
VerrazzanoSpec

 components ComponentSpec (Optional) The Verrazzano components. defaultVolumeSource Kubernetes core/v1.VolumeSource (Optional) Defines the type of volume to be used for persistence for all components unless overridden, and can be one of either EmptyDirVolumeSource or PersistentVolumeClaimVolumeSource. If PersistentVolumeClaimVolumeSource is declared, then the claimName must reference the name of an existing VolumeClaimSpecTemplate declared in the volumeClaimSpecTemplates section. environmentName string (Optional) Name of the installation. This name is part of the endpoint access URLs that are generated. The default value is default. profile ProfileType (Optional) The installation profile to select. Valid values are prod (production), dev (development), and managed-cluster. The default is prod. security SecuritySpec (Optional) Security specifies Verrazzano security configuration. version string (Optional) The version to install. Valid versions can be found here. Defaults to the current version supported by the Verrazzano platform operator. volumeClaimSpecTemplates []VolumeClaimSpecTemplate (Optional) Defines a named set of PVC configurations that can be referenced from components to configure persistent volumes.
status
VerrazzanoStatus

### Acme

(Appears on: Certificate)

Acme identifies the ACME cert issuer.

Field Description
emailAddress
string
(Optional)

environment
string
(Optional)

Environment.

provider
ProviderType

Name of the Acme provider.

### ApplicationOperatorComponent

(Appears on: ComponentSpec)

ApplicationOperatorComponent specifies the Application Operator configuration.

Field Description
enabled
bool
(Optional)

If true, then the Application Operator will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### ArgoCDComponent

(Appears on: ComponentSpec)

ArgoCDComponent specifies the Argo CD configuration.

Field Description
enabled
bool
(Optional)

If true, then Argo CD will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### AuthProxyComponent

(Appears on: ComponentSpec)

AuthProxyComponent specifies the AuthProxy configuration.

Field Description
enabled
bool
(Optional)

If true, then AuthProxy will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### CA

(Appears on: Certificate)

CA identifies the Certificate Authority cert issuer.

Field Description
clusterResourceNamespace
string

The secret namespace.

secretName
string

The secret name.

### CertManagerComponent

(Appears on: ComponentSpec)

CertManagerComponent specifies the cert-manager configuration.

Field Description
certificate
Certificate
(Optional)

The certificate configuration.

enabled
bool
(Optional)

If true, then cert-manager will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### Certificate

(Appears on: CertManagerComponent)

Certificate represents the type of cert issuer for an installation.

Field Description
acme
Acme
(Optional)

The ACME configuration. Either acme or ca must be specified.

ca
CA
(Optional)

The ACME configuration. Either acme or ca must be specified.

### ClusterOperatorComponent

(Appears on: ComponentSpec)

ClusterOperatorComponent specifies the Cluster Operator configuration.

Field Description
enabled
bool
(Optional)

If true, then the Cluster Operator will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### CoherenceOperatorComponent

(Appears on: ComponentSpec)

CoherenceOperatorComponent specifies the Coherence Operator configuration.

Field Description
enabled
bool
(Optional)

If true, then the Coherence Operator will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### CompStateType (string alias)

(Appears on: ComponentStatusDetails)

CompStateType identifies the state of a component.

### ComponentAvailability (string alias)

(Appears on: ComponentStatusDetails)

ComponentAvailability identifies the availability of a Verrazzano Component.

### ComponentSpec

(Appears on: VerrazzanoSpec)

ComponentSpec contains a set of components used by Verrazzano.

Field Description
applicationOperator
ApplicationOperatorComponent
(Optional)

The Application Operator component configuration.

argoCD
ArgoCDComponent
(Optional)

The Argo CD component configuration.

authProxy
AuthProxyComponent
(Optional)

The AuthProxy component configuration.

certManager
CertManagerComponent
(Optional)

The cert-manager component configuration.

clusterOperator
ClusterOperatorComponent
(Optional)

The Cluster Operator component configuration.

coherenceOperator
CoherenceOperatorComponent
(Optional)

The Coherence Operator component configuration.

console
ConsoleComponent
(Optional)

The Verrazzano Console component configuration.

dns
DNSComponent
(Optional)

The DNS component configuration.

fluentd
FluentdComponent
(Optional)

The Fluentd component configuration.

grafana
GrafanaComponent
(Optional)

The Grafana component configuration.

ingressNGINX
IngressNginxComponent
(Optional)

The ingress NGINX component configuration.

istio
IstioComponent
(Optional)

The Istio component configuration.

jaegerOperator
JaegerOperatorComponent
(Optional)

The Jaeger Operator component configuration.

keycloak
KeycloakComponent
(Optional)

The Keycloak component configuration.

kiali
KialiComponent
(Optional)

The Kiali component configuration.

kubeStateMetrics
KubeStateMetricsComponent
(Optional)

The kube-state-metrics component configuration.

mySQLOperator
MySQLOperatorComponent
(Optional)

The MySQL Operator component configuration.

oam
OAMComponent
(Optional)

The OAM component configuration.

opensearch
OpenSearchComponent
(Optional)

The OpenSearch component configuration.

opensearchDashboards
OpenSearchDashboardsComponent
(Optional)

The OpenSearch Dashboards component configuration.

prometheus
PrometheusComponent
(Optional)

The Prometheus component configuration.

prometheusAdapter
(Optional)

prometheusNodeExporter
PrometheusNodeExporterComponent
(Optional)

The Prometheus Node Exporter component configuration.

prometheusOperator
PrometheusOperatorComponent
(Optional)

The Prometheus Operator component configuration.

prometheusPushgateway
PrometheusPushgatewayComponent
(Optional)

The Prometheus Pushgateway component configuration.

rancher
RancherComponent
(Optional)

The Rancher component configuration.

rancherBackup
RancherBackupComponent
(Optional)

The rancherBackup component configuration.

velero
VeleroComponent
(Optional)

The Velero component configuration.

verrazzano
VerrazzanoComponent
(Optional)

The Verrazzano component configuration.

weblogicOperator
WebLogicOperatorComponent
(Optional)

The WebLogic Kubernetes Operator component configuration.

### ComponentStatusDetails

ComponentStatusDetails defines the observed state of a component.

Field Description
available
ComponentAvailability

Whether a component is available for use.

conditions
[]Condition

Information about the current state of a component.

lastReconciledGeneration
int64

The generation of the last Verrazzano resource the Component was successfully reconciled against.

name
string

Name of the component.

reconcilingGeneration
int64

The generation of the Verrazzano resource the Component is currently being reconciled against.

state
CompStateType

The state of a component.

version
string

The version of a component.

### ComponentStatusMap (map[string]*github.com/verrazzano/verrazzano/platform-operator/apis/verrazzano/v1beta1.ComponentStatusDetails alias)

(Appears on: VerrazzanoStatus)

ComponentStatusMap is a map of components status details.

### Condition

(Appears on: ComponentStatusDetails, VerrazzanoStatus)

Condition describes the current state of an installation.

Field Description
lastTransitionTime
string

Last time the condition transitioned from one status to another.

message
string

status
Kubernetes core/v1.ConditionStatus

Status of the condition: one of True, False, or Unknown.

type
ConditionType

Type of condition.

### ConditionType (string alias)

(Appears on: Condition)

ConditionType identifies the condition of the install, uninstall, or upgrade, which can be checked with kubectl wait.

### ConsoleComponent

(Appears on: ComponentSpec)

ConsoleComponent specifies the Verrazzano Console configuration.

Field Description
enabled
bool
(Optional)

If true, then Verrazzano Console will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### DNSComponent

(Appears on: ComponentSpec)

DNSComponent specifies the DNS configuration.

Field Description
external
External
(Optional)

External DNS configuration.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

oci
OCI
(Optional)

Oracle Cloud Infrastructure DNS configuration.

wildcard
Wildcard
(Optional)

Wildcard DNS configuration. This is the default with a domain of nip.io.

### DatabaseInfo

(Appears on: GrafanaComponent)

DatabaseInfo specifies the database connection information for the Grafana DB instance.

Field Description
host
string

The host of the database.

name
string

The name of the database.

### External

(Appears on: DNSComponent)

External DNS type.

Field Description
suffix
string

The suffix for DNS names.

### FluentdComponent

(Appears on: ComponentSpec)

FluentdComponent specifies the Fluentd configuration.

Field Description
enabled
bool
(Optional)

If true, then Fluentd will be installed.

extraVolumeMounts
[]VolumeMount
(Optional)

A list of host path volume mounts, in addition to /var/log, into the Fluentd DaemonSet. The Fluentd component collects log files in the /var/log/containers directory of Kubernetes worker nodes. The /var/log/containers directory may contain symbolic links to files located outside the /var/log directory. If the host path directory containing the log files is located outside /var/log, the Fluentd DaemonSet must have the volume mount of that directory to collect the logs.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

oci
OciLoggingConfiguration
(Optional)

The Oracle Cloud Infrastructure Logging configuration.

opensearchSecret
string
(Optional)

The secret containing the credentials for connecting to OpenSearch. This secret needs to be created in the verrazzano-install namespace prior to creating the Verrazzano custom resource. Specify the OpenSearch login credentials in the username and password fields in this secret. Specify the CA for verifying the OpenSearch certificate in the ca-bundle field, if applicable. The default verrazzano is the secret for connecting to the VMI OpenSearch.

opensearchURL
string
(Optional)

The target OpenSearch URLs. Specify this option in this format. The default http://vmi-system-es-ingest-oidc:8775 is the VMI OpenSearch URL.

### GrafanaComponent

(Appears on: ComponentSpec)

GrafanaComponent specifies the Grafana configuration.

Field Description
database
DatabaseInfo
(Optional)

The information to configure a connection to an external Grafana database.

enabled
bool
(Optional)

If true, then Grafana will be installed.

replicas
int32
(Optional)

The number of pods to replicate. The default is 1.

### IngressNginxComponent

(Appears on: ComponentSpec)

IngressNginxComponent specifies the ingress NGINX configuration.

Field Description
enabled
bool
(Optional)

If true, then ingress NGINX will be installed.

ingressClassName
string
(Optional)

Name of the ingress class used by the ingress controller. Defaults to verrazzano-nginx.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

ports
[]Kubernetes core/v1.ServicePort
(Optional)

The list of port configurations used by the ingress.

type
IngressType
(Optional)

The ingress type. Valid values are LoadBalancer and NodePort. The default value is LoadBalancer. If the ingress type is NodePort, then a valid and accessible IP address must be specified using the controller.service.externalIPs key in the InstallOverrides. For sample usage, see External Load Balancers.

### IngressType (string alias)

(Appears on: IngressNginxComponent)

IngressType is the type of ingress.

### InstallOverrides

InstallOverrides are used to pass installation overrides to components.

Field Description
monitorChanges
bool
(Optional)

If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to true.

overrides
[]Overrides
(Optional)

List of overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. Invalid override values will be ignored.

### InstanceInfo

(Appears on: VerrazzanoStatus)

InstanceInfo details of the installed Verrazzano instance maintained in status field.

Field Description
argoCDUrl
string

The Argo CD UI URL for this Verrazzano installation.

consoleUrl
string

The Console URL for this Verrazzano installation.

grafanaUrl
string

The Grafana URL for this Verrazzano installation.

jaegerUrl
string

The Jaeger UI URL for this Verrazzano installation.

keyCloakUrl
string

The KeyCloak URL for this Verrazzano installation.

kialiUrl
string

The Kiali URL for this Verrazzano installation.

openSearchDashboardsUrl
string

The OpenSearch Dashboards URL for this Verrazzano installation.

openSearchUrl
string

The OpenSearch URL for this Verrazzano installation.

prometheusUrl
string

The Prometheus URL for this Verrazzano installation.

rancherUrl
string

The Rancher URL for this Verrazzano installation.

### IstioComponent

(Appears on: ComponentSpec)

IstioComponent specifies the Istio configuration.

Field Description
enabled
bool
(Optional)

If true, then Istio will be installed.

injectionEnabled
bool
(Optional)

Istio sidecar injection enabled for installed components. Default is true.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for default IstioOperator. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here Passing through an invalid IstioOperator resource will result in an error.

### JaegerOperatorComponent

(Appears on: ComponentSpec)

JaegerOperatorComponent specifies the Jaeger Operator configuration.

Field Description
enabled
bool
(Optional)

If true, then Jaeger Operator will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### KeycloakComponent

(Appears on: ComponentSpec)

KeycloakComponent specifies the Keycloak configuration.

Field Description
enabled
bool
(Optional)

If true, then Keycloak will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

mysql
MySQLComponent
(Optional)

Contains the MySQL component configuration needed for Keycloak.

### KialiComponent

(Appears on: ComponentSpec)

KialiComponent specifies the Kiali configuration.

Field Description
enabled
bool
(Optional)

If true, then Kiali will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### KubeStateMetricsComponent

(Appears on: ComponentSpec)

KubeStateMetricsComponent specifies the kube-state-metrics configuration.

Field Description
enabled
bool
(Optional)

If true, then kube-state-metrics will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### MySQLComponent

(Appears on: KeycloakComponent)

MySQLComponent specifies the MySQL configuration.

Field Description
InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

volumeSource
Kubernetes core/v1.VolumeSource
(Optional)

Defines the type of volume to be used for persistence for Keycloak/MySQL, and can be one of either EmptyDirVolumeSource or PersistentVolumeClaimVolumeSource. If PersistentVolumeClaimVolumeSource is declared, then the claimName must reference the name of a VolumeClaimSpecTemplate declared in the volumeClaimSpecTemplates section.

### MySQLOperatorComponent

(Appears on: ComponentSpec)

MySQLOperatorComponent specifies the MySQL Operator configuration.

Field Description
enabled
bool
(Optional)

If true, then MySQL Operator will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### OAMComponent

(Appears on: ComponentSpec)

OAMComponent specifies the OAM configuration.

Field Description
enabled
bool
(Optional)

If true, then OAM will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### OCI

(Appears on: DNSComponent)

OCI DNS type.

Field Description
dnsScope
string
(Optional)

Scope of the Oracle Cloud Infrastructure DNS zone (PRIVATE, GLOBAL). If not specified, then defaults to GLOBAL.

dnsZoneCompartmentOCID
string

The Oracle Cloud Infrastructure DNS compartment OCID.

dnsZoneOCID
string

The Oracle Cloud Infrastructure DNS zone OCID.

dnsZoneName
string

Name of Oracle Cloud Infrastructure DNS zone.

ociConfigSecret
string

Name of the Oracle Cloud Infrastructure configuration secret. Generate a secret based on the Oracle Cloud Infrastructure configuration profile you want to use. You can specify a profile other than DEFAULT and specify the secret name. See instructions by running ./install/create_oci_config_secret.sh.

### OciLoggingConfiguration

(Appears on: FluentdComponent)

OciLoggingConfiguration is the Oracle Cloud Infrastructure logging configuration for Fluentd.

Field Description
apiSecret
string
(Optional)

The name of the secret containing the Oracle Cloud Infrastructure API configuration and private key.

defaultAppLogId
string

The OCID of the Oracle Cloud Infrastructure Log that will collect application logs.

systemLogId
string

The OCID of the Oracle Cloud Infrastructure Log that will collect system logs.

### OpenSearchComponent

(Appears on: ComponentSpec)

OpenSearchComponent specifies the OpenSearch configuration.

Field Description
enabled
bool
(Optional)

If true, then OpenSearch will be installed.

nodes
[]OpenSearchNode
(Optional)

A list of OpenSearch node groups. For sample usage, see Customize OpenSearch.

policies
[]VMO /vmcontroller/v1.IndexManagementPolicy
(Optional)

A list of Index State Management policies to enable on OpenSearch.

plugins
VMO /vmcontroller/v1.OpenSearchPlugins
(Optional)

Enable to add 3rd Party / Custom plugins not offered in the default OpenSearch image.

disableDefaultPolicy
bool

To disable the default ISM policies.

### OpenSearchDashboardsComponent

(Appears on: ComponentSpec)

OpenSearchDashboardsComponent specifies the OpenSearch Dashboards configuration.

Field Description
enabled
bool
(Optional)

If true, then OpenSearch Dashboards will be installed.

replicas
int32

The number of pods to replicate. The default is 1.

plugins
VMO /vmcontroller/v1.OpenSearchDashboardsPlugins
(Optional)

Enable to add 3rd Party / Custom plugins not offered in the default OpenSearch-Dashboard image

### OpenSearchNode

(Appears on: OpenSearchComponent)

OpenSearchNode specifies a node group in the OpenSearch cluster.

Field Description
name
string

Name of the node group.

replicas
int32
(Optional)

Node group replica count.

resources
Kubernetes core/v1.ResourceRequirements
(Optional)

Kubernetes container resources for nodes in the node group.

roles
[]VMO /vmcontroller/v1.NodeRole

Role or roles that nodes in the group will assume: may be master, data, and/or ingest.

storage
OpenSearchNodeStorage
(Optional)

Storage settings for the node group.

javaOpts
string
(Optional)

JavaOpts settings for the OpenSearch JVM.

### OpenSearchNodeStorage

(Appears on: OpenSearchNode)

Field Description
size
string

Node group storage size expressed as a Quantity.

### Overrides

(Appears on: InstallOverrides)

Overrides identifies overrides for a component.

Field Description
configMapRef
Kubernetes core/v1.ConfigMapKeySelector
(Optional)

Selector for ConfigMap containing override data.

secretRef
Kubernetes core/v1.SecretKeySelector
(Optional)

Selector for Secret containing override data.

values
Kubernetes apiextensions/v1.JSON
(Optional)

Configure overrides using inline YAML.

### ProfileType (string alias)

(Appears on: VerrazzanoSpec)

ProfileType is the type of installation profile.

(Appears on: ComponentSpec)

Field Description
enabled
bool
(Optional)

If true, then Prometheus Adaptor will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### PrometheusComponent

(Appears on: ComponentSpec)

PrometheusComponent specifies the Prometheus configuration.

Field Description
enabled
bool
(Optional)

If true, then Prometheus will be installed. This is a legacy setting; the preferred way to configure Prometheus is using the PrometheusOperatorComponent.

### PrometheusNodeExporterComponent

(Appears on: ComponentSpec)

PrometheusNodeExporterComponent specifies the Prometheus Node Exporter configuration.

Field Description
enabled
bool
(Optional)

If true, then Prometheus Node Exporter will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### PrometheusOperatorComponent

(Appears on: ComponentSpec)

PrometheusOperatorComponent specifies the Prometheus Operator configuration.

Field Description
enabled
bool
(Optional)

If true, then Prometheus Operator will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### PrometheusPushgatewayComponent

(Appears on: ComponentSpec)

PrometheusPushgatewayComponent specifies the Prometheus Pushgateway configuration.

Field Description
enabled
bool
(Optional)

If true, then Prometheus Pushgateway will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### ProviderType (string alias)

(Appears on: Acme)

ProviderType identifies Acme provider type.

### RancherBackupComponent

(Appears on: ComponentSpec)

RancherBackupComponent specifies the rancherBackup configuration.

Field Description
enabled
bool
(Optional)

If true, then rancherBackup will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### RancherComponent

(Appears on: ComponentSpec)

RancherComponent specifies the Rancher configuration.

Field Description
enabled
bool
(Optional)

If true, then Rancher will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

keycloakAuthEnabled
bool
(Optional)

KeycloakAuthEnabled specifies whether the Keycloak Auth provider is enabled. Default is false.

### SecuritySpec

(Appears on: VerrazzanoSpec)

SecuritySpec defines the security configuration for Verrazzano.

Field Description
adminSubjects
[]Kubernetes rbac/v1.Subject
(Optional)

Specifies subjects that should be bound to the verrazzano-admin role.

monitorSubjects
[]Kubernetes rbac/v1.Subject
(Optional)

Specifies subjects that should be bound to the verrazzano-monitor role.

### VeleroComponent

(Appears on: ComponentSpec)

VeleroComponent specifies the Velero configuration.

Field Description
enabled
bool
(Optional)

If true, then Velero will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### VerrazzanoComponent

(Appears on: ComponentSpec)

VerrazzanoComponent specifies the Verrazzano configuration.

Field Description
enabled
bool
(Optional)

If true, then Verrazzano will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### VerrazzanoSpec

(Appears on: Verrazzano)

VerrazzanoSpec defines the desired state of Verrazzano resource.

Field Description
components
ComponentSpec
(Optional)

The Verrazzano components.

defaultVolumeSource
Kubernetes core/v1.VolumeSource
(Optional)

Defines the type of volume to be used for persistence for all components unless overridden, and can be one of either EmptyDirVolumeSource or PersistentVolumeClaimVolumeSource. If PersistentVolumeClaimVolumeSource is declared, then the claimName must reference the name of an existing VolumeClaimSpecTemplate declared in the volumeClaimSpecTemplates section.

environmentName
string
(Optional)

Name of the installation. This name is part of the endpoint access URLs that are generated. The default value is default.

profile
ProfileType
(Optional)

The installation profile to select. Valid values are prod (production), dev (development), and managed-cluster. The default is prod.

security
SecuritySpec
(Optional)

Security specifies Verrazzano security configuration.

version
string
(Optional)

The version to install. Valid versions can be found here. Defaults to the current version supported by the Verrazzano platform operator.

volumeClaimSpecTemplates
[]VolumeClaimSpecTemplate
(Optional)

Defines a named set of PVC configurations that can be referenced from components to configure persistent volumes.

### VerrazzanoStatus

(Appears on: Verrazzano)

VerrazzanoStatus defines the observed state of a Verrazzano resource.

Field Description
available
string

The summary of Verrazzano component availability.

components
ComponentStatusMap

States of the individual installed components.

conditions
[]Condition

The latest available observations of an object’s current state.

state
VzStateType

State of the Verrazzano custom resource.

instance
InstanceInfo

The Verrazzano instance info.

version
string

The version of Verrazzano that is installed.

### VolumeClaimSpecTemplate

(Appears on: VerrazzanoSpec)

VolumeClaimSpecTemplate Contains common PVC configuration that can be referenced from Components; these do not actually result in generated PVCs, but can be used to provide common configuration to components that declare a PersistentVolumeClaimVolumeSource.

Field Description
metadata
Kubernetes meta/v1.ObjectMeta

Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
Kubernetes core/v1.PersistentVolumeClaimSpec

A PersistentVolumeClaimSpec template that can be referenced by a Component to override its default storage settings for a profile. At present, only a subset of the resources.requests object are honored depending on the component.

 accessModes []Kubernetes core/v1.PersistentVolumeAccessMode (Optional) accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 selector Kubernetes meta/v1.LabelSelector (Optional) selector is a label query over volumes to consider for binding. resources Kubernetes core/v1.ResourceRequirements (Optional) resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources volumeName string (Optional) volumeName is the binding reference to the PersistentVolume backing this claim. storageClassName string (Optional) storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 volumeMode Kubernetes core/v1.PersistentVolumeMode (Optional) volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. dataSource Kubernetes core/v1.TypedLocalObjectReference (Optional) dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. dataSourceRef Kubernetes core/v1.TypedLocalObjectReference (Optional) dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.

### VolumeMount

(Appears on: FluentdComponent)

VolumeMount defines a hostPath type Volume mount.

Field Description
destination
string
(Optional)

The destination path on the Fluentd Container, defaults to the source host path.

readOnly
bool
(Optional)

Specifies if the volume mount is read-only, defaults to true.

source
string

The source host path.

### VzStateType (string alias)

(Appears on: VerrazzanoStatus)

VzStateType identifies the state of a Verrazzano installation.

### WebLogicOperatorComponent

(Appears on: ComponentSpec)

WebLogicOperatorComponent specifies the WebLogic Kubernetes Operator configuration.

Field Description
enabled
bool
(Optional)

If true, then the WebLogic Kubernetes Operator will be installed.

InstallOverrides
InstallOverrides

(Members of InstallOverrides are embedded into this type.)

(Optional)

List of Overrides for the default values.yaml file for the component Helm chart. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here and invalid values will be ignored.

### Wildcard

(Appears on: DNSComponent)

Wildcard DNS type.

Field Description
domain
string

The type of wildcard DNS domain. For example, nip.io, sslip.io, and such.

Generated with gen-crd-api-reference-docs