Verrazzano Enterprise Container Platform – API Reference

Docs: Multicluster and Verrazzano Project

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

clusters.verrazzano.io/v1alpha1

clusters.verrazzano.io/v1alpha1

Resource Types:

MultiClusterApplicationConfiguration

MultiClusterApplicationConfiguration specifies the multicluster application API.

Field Description

apiVersion
string clusters.verrazzano.io/v1alpha1

kind
string MultiClusterApplicationConfiguration

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
MultiClusterApplicationConfigurationSpec

The desired state of a multicluster application resource.

`placement` Placement	Clusters in which the application is to be created.
`secrets` []string	(Optional) List of secrets used by the application. These secrets must be created in the application’s namespace before deploying a MultiClusterApplicationConfiguration resource.
`template` ApplicationConfigurationTemplate	Template containing the metadata and spec for an OAM applicationConfiguration resource.

status
MultiClusterResourceStatus

The observed state of a multicluster application resource.

MultiClusterComponent

MultiClusterComponent specifies the MultiCluster Component API.

Field Description

apiVersion
string clusters.verrazzano.io/v1alpha1

kind
string MultiClusterComponent

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
MultiClusterComponentSpec

The desired state of a MultiCluster Component resource.

`placement` Placement	Clusters in which the component is to be created.
`template` ComponentTemplate	Template containing the metadata and spec for an OAM component.

status
MultiClusterResourceStatus

The observed state of a MultiCluster Component resource.

MultiClusterConfigMap

MultiClusterConfigMap specifies the MultiCluster ConfigMap API.

Field Description

apiVersion
string clusters.verrazzano.io/v1alpha1

kind
string MultiClusterConfigMap

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
MultiClusterConfigMapSpec

The desired state of a MultiCluster ConfigMap resource.

`placement` Placement	Clusters in which the ConfigMap is to be created.
`template` ConfigMapTemplate	The embedded Kubernetes ConfigMap.

status
MultiClusterResourceStatus

The observed state of a MultiCluster ConfigMap resource.

MultiClusterSecret

MultiClusterSecret specifies the MultiCluster Secret API.

Field Description

apiVersion
string clusters.verrazzano.io/v1alpha1

kind
string MultiClusterSecret

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
MultiClusterSecretSpec

The desired state of a MultiCluster Secret resource.

`placement` Placement	Clusters in which the secret is to be created.
`template` SecretTemplate	The embedded Kubernetes secret.

status
MultiClusterResourceStatus

The observed state of a MultiCluster Secret resource.

VerrazzanoProject

VerrazzanoProject specifies the Verrazzano Projects API.

Field Description

apiVersion
string clusters.verrazzano.io/v1alpha1

kind
string VerrazzanoProject

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
VerrazzanoProjectSpec

The desired state of a Verrazzano Project resource.

`placement` Placement	Clusters on which the namespaces are to be created.
`template` ProjectTemplate	The project template.

status
MultiClusterResourceStatus

The observed state of a Verrazzano Project resource.

ApplicationConfigurationTemplate

(Appears on:MultiClusterApplicationConfigurationSpec)

ApplicationConfigurationTemplate has the metadata and embedded spec of the OAM applicationConfiguration resource.

Field Description

metadata
EmbeddedObjectMeta

Metadata describing the application.

spec
OAM core/v1alpha2.ApplicationConfigurationSpec

The embedded OAM application specification.

components
[]OAM core/v1alpha2.ApplicationConfigurationComponent

Components of which this ApplicationConfiguration consists. Each component will be used to instantiate a workload.

Cluster

(Appears on:Placement)

Cluster contains the name of a single cluster.

Field	Description
`name` string	The name of a cluster.

ClusterLevelStatus

(Appears on:MultiClusterResourceStatus)

ClusterLevelStatus describes the status of the multicluster resource in a specific cluster.

Field	Description
`lastUpdateTime` string	Last update time of the resource state in this cluster.
`message` string	Message details about the status in this cluster.
`name` string	Name of the cluster.
`state` StateType	State of the resource in this cluster.

ComponentTemplate

(Appears on:MultiClusterComponentSpec)

ComponentTemplate has the metadata and embedded spec of the OAM component.

Field Description

metadata
EmbeddedObjectMeta

Metadata describing the component.

spec
OAM core/v1alpha2.ComponentSpec

The embedded OAM component specification.

`workload` Kubernetes runtime.RawExtension	A Workload that will be created for each ApplicationConfiguration that includes this Component. Workload is an instance of a workloadDefinition. We either use the GVK info or a special “type” field in the workload to associate the content of the workload with its workloadDefinition
`parameters` []OAM core/v1alpha2.ComponentParameter	(Optional) Parameters exposed by this component. ApplicationConfigurations that reference this component may specify values for these parameters, which will in turn be injected into the embedded workload.

Condition

(Appears on:MultiClusterResourceStatus)

Condition describes current state of a multicluster resource.

Field	Description
`lastTransitionTime` string	(Optional) Last time the condition transitioned from one status to another.
`message` string	(Optional) A message with details about the last transition.
`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 multicluster resource which can be checked with kubectl wait.

Value	Description
"DeployComplete"	DeployComplete means deployment to the specified cluster completed successfully.
"DeployFailed"	DeployFailed means the deployment to the specified cluster has failed.
"DeployPending"	DeployPending means deployment to the specified cluster is in progress.

ConfigMapTemplate

(Appears on:MultiClusterConfigMapSpec)

ConfigMapTemplate has the metadata and spec of the Kubernetes ConfigMap.

Field	Description
`binaryData` map[string][]byte	Corresponds to the `binaryData` field of the `struct` ConfigMap defined in types.go.
`data` map[string]string	Corresponds to the `data` field of the `struct` ConfigMap defined in types.go.
`immutable` bool	Corresponds to the `immutable` field of the `struct` ConfigMap defined in types.go.
`metadata` EmbeddedObjectMeta	Metadata describing the ConfigMap.

EmbeddedObjectMeta

(Appears on:ApplicationConfigurationTemplate, ComponentTemplate, ConfigMapTemplate, SecretTemplate)

EmbeddedObjectMeta is metadata describing a resource.

Field	Description
`annotations` map[string]string	(Optional) Annotations for the resource.
`labels` map[string]string	(Optional) Labels for the resource.
`name` string	(Optional) Name of the resource.
`namespace` string	(Optional) Namespace of the resource.

MultiClusterApplicationConfigurationSpec

(Appears on:MultiClusterApplicationConfiguration)

MultiClusterApplicationConfigurationSpec defines the desired state of a multicluster application.

Field	Description
`placement` Placement	Clusters in which the application is to be created.
`secrets` []string	(Optional) List of secrets used by the application. These secrets must be created in the application’s namespace before deploying a MultiClusterApplicationConfiguration resource.
`template` ApplicationConfigurationTemplate	Template containing the metadata and spec for an OAM applicationConfiguration resource.

MultiClusterComponentSpec

(Appears on:MultiClusterComponent)

MultiClusterComponentSpec defines the desired state of a MultiCluster Component.

Field	Description
`placement` Placement	Clusters in which the component is to be created.
`template` ComponentTemplate	Template containing the metadata and spec for an OAM component.

MultiClusterConfigMapSpec

(Appears on:MultiClusterConfigMap)

MultiClusterConfigMapSpec defines the desired state of a MultiCluster ConfigMap.

Field	Description
`placement` Placement	Clusters in which the ConfigMap is to be created.
`template` ConfigMapTemplate	The embedded Kubernetes ConfigMap.

MultiClusterResourceStatus

(Appears on:MultiClusterApplicationConfiguration, MultiClusterComponent, MultiClusterConfigMap, MultiClusterSecret, VerrazzanoProject)

MultiClusterResourceStatus is the runtime status of a multicluster resource.

Field Description

Field	Description
`clusters` []ClusterLevelStatus	Status information for each cluster.
`conditions` []Condition	The current state of a multicluster resource.
`state` StateType	The state of the multicluster resource. State values are case-sensitive and formatted as follows: `Failed`: deployment to cluster failed `Pending`: deployment to cluster is in progress `Succeeded`: deployment to cluster successfully completed

clusters
[]ClusterLevelStatus

Status information for each cluster.

conditions
[]Condition

The current state of a multicluster resource.

state
StateType

The state of the multicluster resource. State values are case-sensitive and formatted as follows:

Failed: deployment to cluster failed
Pending: deployment to cluster is in progress
Succeeded: deployment to cluster successfully completed

MultiClusterSecretSpec

(Appears on:MultiClusterSecret)

MultiClusterSecretSpec defines the desired state of a MultiCluster Secret.

Field	Description
`placement` Placement	Clusters in which the secret is to be created.
`template` SecretTemplate	The embedded Kubernetes secret.

NamespaceTemplate

(Appears on:ProjectTemplate)

NamespaceTemplate contains the metadata and specification of a Kubernetes namespace.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Kubernetes core/v1.NamespaceSpec

The specification of a namespace.

finalizers
[]Kubernetes core/v1.FinalizerName

(Optional)

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

NetworkPolicyTemplate

(Appears on:ProjectTemplate)

NetworkPolicyTemplate contains the metadata and specification of a Kubernetes NetworkPolicy.

NOTE

To add an application NetworkPolicy, see NetworkPolicies for applications.

Field Description

metadata
Kubernetes meta/v1.ObjectMeta (Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Kubernetes networking/v1.NetworkPolicySpec

The specification of a network policy.

`podSelector` Kubernetes meta/v1.LabelSelector	Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace.
`ingress` []Kubernetes networking/v1.NetworkPolicyIngressRule	(Optional) List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default)
`egress` []Kubernetes networking/v1.NetworkPolicyEgressRule	(Optional) List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8
`policyTypes` []Kubernetes networking/v1.PolicyType	(Optional) List of rule types that the NetworkPolicy relates to. Valid options are [“Ingress”], [“Egress”], or [“Ingress”, “Egress”]. If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ “Egress” ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include “Egress” (since such a policy would not include an Egress section and would otherwise default to just [ “Ingress” ]). This field is beta-level in 1.8

Placement

(Appears on:MultiClusterApplicationConfigurationSpec, MultiClusterComponentSpec, MultiClusterConfigMapSpec, MultiClusterSecretSpec, VerrazzanoProjectSpec)

Placement contains the name of each cluster where a resource will be located.

Field	Description
`clusters` []Cluster	List of clusters.

ProjectTemplate

(Appears on:VerrazzanoProjectSpec)

ProjectTemplate contains the list of namespaces to create and the optional security configuration for each namespace.

Field	Description
`namespaces` []NamespaceTemplate	The list of application namespaces to create for this project.
`networkPolicies` []NetworkPolicyTemplate	(Optional) Network policies applied to namespaces in the project.
`security` SecuritySpec	(Optional) The project security configuration.

SecretTemplate

(Appears on:MultiClusterSecretSpec)

SecretTemplate has the metadata and spec of the Kubernetes Secret.

Field	Description
`data` map[string][]byte	Corresponds to the data field of the struct Secret defined in types.go.
`metadata` EmbeddedObjectMeta	Metadata describing the secret.
`stringData` map[string]string	Corresponds to the `stringData` field of the `struct` Secret defined in types.go.
`type` Kubernetes core/v1.SecretType	The type of secret.

SecuritySpec

(Appears on:ProjectTemplate)

SecuritySpec defines the security configuration for a Verrazzano Project.

Field	Description
`projectAdminSubjects` []Kubernetes rbac/v1.Subject	(Optional) The subjects to bind to the `verrazzano-project-admin` role.
`projectMonitorSubjects` []Kubernetes rbac/v1.Subject	(Optional) The subjects to bind to the `verrazzano-project-monitoring` role.

StateType (`string` alias)

(Appears on:ClusterLevelStatus, MultiClusterResourceStatus)

StateType identifies the state of a multicluster resource.

Value	Description
"Failed"	Failed is the state when deploy to specified cluster has failed.
"Pending"	Pending is the state when deploy to specified cluster is in progress.
"Succeeded"	Succeeded is the state when deploy to specified cluster is completed.

VerrazzanoProjectSpec

(Appears on:VerrazzanoProject)

VerrazzanoProjectSpec defines the desired state of a Verrazzano Project.

Field	Description
`placement` Placement	Clusters on which the namespaces are to be created.
`template` ProjectTemplate	The project template.

Generated with gen-crd-api-reference-docs on git commit 238db2c3e.

Docs: Traits and Workloads

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

oam.verrazzano.io/v1alpha1

oam.verrazzano.io/v1alpha1

Resource Types:

IngressTrait

IngressTrait specifies the ingress traits API.

Field Description

apiVersion
string oam.verrazzano.io/v1alpha1

kind
string IngressTrait

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
IngressTraitSpec

`rules` []IngressRule	A list of ingress rules for an ingress trait.
`tls` IngressSecurity	(Optional) The security parameters for an ingress trait. This is required only if specific hosts are given in an IngressRule.
`workloadRef` OAM common/v1.TypedReference	The WorkloadReference of the workload to which this trait applies. This value is populated by the OAM runtime when an ApplicationConfiguration resource is processed. When the ApplicationConfiguration is processed, a trait and a workload resource are created from the content of the ApplicationConfiguration. The WorkloadReference is provided in the trait by OAM to ensure that the trait controller can find the workload associated with the component containing the trait within the original ApplicationConfiguration.

status
IngressTraitStatus

The observed state of an ingress trait and related resources.

LoggingTrait

LoggingTrait specifies the logging traits API.

Field Description

apiVersion
string oam.verrazzano.io/v1alpha1

kind
string LoggingTrait

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
LoggingTraitSpec

`imagePullPolicy` string	(Optional) The optional image pull policy for the Fluentd image provided by the user.
`loggingConfig` string	The configuration provided by the user for the Fluentd configuration that consists of fluentd.conf: `<source>\n ... and so on ...\n`.
`loggingImage` string	(Optional) The name of the custom Fluentd image.
`workloadRef` OAM common/v1.TypedReference	The WorkloadReference of the workload to which this trait applies. This value is populated by the OAM runtime when an ApplicationConfiguration resource is processed. When the ApplicationConfiguration is processed, a trait and a workload resource are created from the content of the ApplicationConfiguration. The WorkloadReference is provided in the trait by OAM to ensure that the trait controller can find the workload associated with the component containing the trait within the original ApplicationConfiguration.

status
LoggingTraitStatus

The observed state of a logging trait and related resources.

MetricsTrait

MetricsTrait specifies the metrics trait API.

Field Description

apiVersion
string oam.verrazzano.io/v1alpha1

kind
string MetricsTrait

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
MetricsTraitSpec

`enabled` bool	(Optional) Specifies whether metrics collection is enabled. Defaults to `true`.
`path` string	(Optional) The HTTP path for the related metrics endpoint. Defaults to `/metrics`.
`port` int	(Optional) The HTTP port for the related metrics trait. Defaults to `8080`.
`ports` []PortSpec	(Optional) The HTTP endpoints for the related metrics.
`scraper` string	(Optional) The Prometheus deployment used to scrape the related metrics endpoints. By default, the Verrazzano-supplied Prometheus component is used to scrape the endpoint.
`secret` string	(Optional) The name of an opaque secret (for example, `username` and `password`) within the workload’s namespace for metrics endpoint access.
`workloadRef` OAM common/v1.TypedReference	The WorkloadReference of the workload to which this trait applies. This value is populated by the OAM runtime when an ApplicationConfiguration resource is processed. When the ApplicationConfiguration is processed, a trait and a workload resource are created from the content of the ApplicationConfiguration. The WorkloadReference is provided in the trait by OAM to ensure that the trait controller can find the workload associated with the component containing the trait within the original ApplicationConfiguration.

status
MetricsTraitStatus

The observed state of a metrics trait and related resources.

VerrazzanoCoherenceWorkload

VerrazzanoCoherenceWorkload specifies the Verrazzano Coherence workload API.

Field Description

apiVersion
string oam.verrazzano.io/v1alpha1

kind
string VerrazzanoCoherenceWorkload

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
VerrazzanoCoherenceWorkloadSpec

The desired state of a Verrazzano Coherence workload.

template
Kubernetes runtime.RawExtension

The metadata and spec for the underlying Coherence resource.

status
VerrazzanoCoherenceWorkloadStatus

The observed state of a Verrazzano Coherence workload.

VerrazzanoHelidonWorkload

VerrazzanoHelidonWorkload specifies the Verrazzano Helidon workload API.

Field Description

apiVersion
string oam.verrazzano.io/v1alpha1

kind
string VerrazzanoHelidonWorkload

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
VerrazzanoHelidonWorkloadSpec

The desired state of a Verrazzano Helidon workload.

`deploymentTemplate` DeploymentTemplate	An embedded Helidon application deployment.
`serviceTemplate` ServiceTemplate	An embedded Helidon application service.

status
VerrazzanoHelidonWorkloadStatus

The observed state of a Verrazzano Helidon workload.

VerrazzanoWebLogicWorkload

VerrazzanoWebLogicWorkload specifies the Verrazzano WebLogic workload API.

Field Description

apiVersion
string oam.verrazzano.io/v1alpha1

kind
string VerrazzanoWebLogicWorkload

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
VerrazzanoWebLogicWorkloadSpec

The desired state of a Verrazzano WebLogic workload.

`template` VerrazzanoWebLogicWorkloadTemplate	The metadata and spec for the underlying Domain resource.
`clusters` []VerrazzanoWebLogicWorkloadTemplate

status
VerrazzanoWebLogicWorkloadStatus

The observed state of a Verrazzano WebLogic workload.

AuthorizationPolicy

(Appears on:IngressPath)

AuthorizationPolicy defines the set of rules for authorizing a request.

Field	Description
`rules` []AuthorizationRule	Rules are used to match requests from request principals to specific paths given an optional list of conditions.

AuthorizationRule

(Appears on:AuthorizationPolicy)

AuthorizationRule matches requests from a list of request principals that access a specific path subject to a list of conditions.

Field	Description
`from` AuthorizationRuleFrom	Specifies the request principals for access to a request. An asterisk (*) will match when the value is not empty, for example, if any request principal is found in the request.
`when` []AuthorizationRuleCondition	(Optional) Specifies a list of additional conditions for access to a request.

AuthorizationRuleCondition

(Appears on:AuthorizationRule)

AuthorizationRuleCondition provides additional required attributes for authorization.

Field	Description
`key` string	The name of a request attribute.
`values` []string	A list of allowed values for the attribute.

AuthorizationRuleFrom

(Appears on:AuthorizationRule)

AuthorizationRuleFrom includes a list of request principals.

Field	Description
`requestPrincipals` []string	Specifies the request principals for access to a request.

DeploymentTemplate

(Appears on:VerrazzanoHelidonWorkloadSpec)

DeploymentTemplate specifies the metadata and pod spec of a Helidon workload.

Field	Description
`metadata` Kubernetes meta/v1.ObjectMeta	Metadata about a Helidon application. Refer to the Kubernetes API documentation for the fields of the `metadata` field.
`podSpec` Kubernetes core/v1.PodSpec	The pod spec of a Helidon application.
`selector` Kubernetes meta/v1.LabelSelector	(Optional) Label selector of a Helidon application.
`strategy` Kubernetes apps/v1.DeploymentStrategy	(Optional) The replacement strategy of a Helidon application.

IngressDestination

(Appears on:IngressRule)

IngressDestination specifies a specific destination host and port for the ingress paths.

NOTE

If there are multiple ports defined for a service, then the destination port must be specified OR the service port name must have the prefix http.

Field	Description
`host` string	(Optional) Destination host.
`httpCookie` IngressDestinationHTTPCookie	(Optional) Session affinity cookie.
`port` uint32	(Optional) Destination port.

IngressDestinationHTTPCookie

(Appears on:IngressDestination)

IngressDestinationHTTPCookie specifies a session affinity cookie for an ingress trait.

Field	Description
`name` string	(Optional) The name of the HTTP cookie.
`path` string	(Optional) The path of the HTTP cookie.
`ttl` time.Duration	(Optional) The lifetime of the HTTP cookie (in seconds).

IngressPath

(Appears on:IngressRule)

IngressPath specifies a specific path to be exposed for an ingress trait.

Field Description

path
string

(Optional)

If no path is provided, then it defaults to forward slash (/).

pathType
string

(Optional)

Path type values are case-sensitive and formatted as follows:

exact: exact string match
prefix: prefix-based match
regex: regex-based match

Defaults to prefix if path specified is /; otherwise, defaults to exact.

authorizationPolicy
AuthorizationPolicy

(Optional)

Defines the set of rules for authorizing a request.

IngressRule

(Appears on:IngressTraitSpec)

IngressRule specifies a rule for an ingress trait.

Field	Description
`destination` IngressDestination	(Optional) The destination host and port for the ingress paths.
`hosts` []string	(Optional) One or more hosts exposed by the ingress trait. Wildcard hosts or hosts that are empty are filtered out. If there are no valid hosts provided, then a DNS host name is automatically generated and used.
`paths` []IngressPath	The paths to be exposed for an ingress trait.

IngressSecurity

(Appears on:IngressTraitSpec)

IngressSecurity specifies the secret containing the certificate securing the transport for an ingress trait.

Field	Description
`secretName` string	The name of a secret containing the certificate securing the transport. The specification of a secret here implies that a certificate was created for specific hosts, as specified in an IngressRule.

IngressTraitSpec

(Appears on:IngressTrait)

IngressTraitSpec specifies the desired state of an ingress trait.

Field	Description
`rules` []IngressRule	A list of ingress rules for an ingress trait.
`tls` IngressSecurity	(Optional) The security parameters for an ingress trait. This is required only if specific hosts are given in an IngressRule.
`workloadRef` OAM common/v1.TypedReference	The WorkloadReference of the workload to which this trait applies. This value is populated by the OAM runtime when an ApplicationConfiguration resource is processed. When the ApplicationConfiguration is processed, a trait and a workload resource are created from the content of the ApplicationConfiguration. The WorkloadReference is provided in the trait by OAM to ensure that the trait controller can find the workload associated with the component containing the trait within the original ApplicationConfiguration.

IngressTraitStatus

(Appears on:IngressTrait)

IngressTraitStatus specifies the observed state of an ingress trait and related resources.

Field Description

ConditionedStatus
OAM common/v1.ConditionedStatus

(Members of ConditionedStatus are embedded into this type.)

Reconcile status of this ingress trait.

resources
[]OAM common/v1.TypedReference

The resources managed by this ingress trait.

LoggingTraitSpec

(Appears on:LoggingTrait)

LoggingTraitSpec specifies the desired state of a logging trait.

Field	Description
`imagePullPolicy` string	(Optional) The optional image pull policy for the Fluentd image provided by the user.
`loggingConfig` string	The configuration provided by the user for the Fluentd configuration that consists of fluentd.conf: `<source>\n ... and so on ...\n`.
`loggingImage` string	(Optional) The name of the custom Fluentd image.
`workloadRef` OAM common/v1.TypedReference	The WorkloadReference of the workload to which this trait applies. This value is populated by the OAM runtime when an ApplicationConfiguration resource is processed. When the ApplicationConfiguration is processed, a trait and a workload resource are created from the content of the ApplicationConfiguration. The WorkloadReference is provided in the trait by OAM to ensure that the trait controller can find the workload associated with the component containing the trait within the original ApplicationConfiguration.

LoggingTraitStatus

(Appears on:LoggingTrait)

LoggingTraitStatus specifies the observed state of a logging trait and related resources.

Field Description

ConditionedStatus
OAM common/v1.ConditionedStatus

(Members of ConditionedStatus are embedded into this type.)

Reconcile status of this logging trait.

resources
[]OAM common/v1.TypedReference

The resources managed by this logging trait.

MetricsTraitSpec

(Appears on:MetricsTrait)

MetricsTraitSpec specifies the desired state of a metrics trait.

Field	Description
`enabled` bool	(Optional) Specifies whether metrics collection is enabled. Defaults to `true`.
`path` string	(Optional) The HTTP path for the related metrics endpoint. Defaults to `/metrics`.
`port` int	(Optional) The HTTP port for the related metrics trait. Defaults to `8080`.
`ports` []PortSpec	(Optional) The HTTP endpoints for the related metrics.
`scraper` string	(Optional) The Prometheus deployment used to scrape the related metrics endpoints. By default, the Verrazzano-supplied Prometheus component is used to scrape the endpoint.
`secret` string	(Optional) The name of an opaque secret (for example, `username` and `password`) within the workload’s namespace for metrics endpoint access.
`workloadRef` OAM common/v1.TypedReference	The WorkloadReference of the workload to which this trait applies. This value is populated by the OAM runtime when an ApplicationConfiguration resource is processed. When the ApplicationConfiguration is processed, a trait and a workload resource are created from the content of the ApplicationConfiguration. The WorkloadReference is provided in the trait by OAM to ensure that the trait controller can find the workload associated with the component containing the trait within the original ApplicationConfiguration.

MetricsTraitStatus

(Appears on:MetricsTrait)

MetricsTraitStatus defines the observed state of a metrics trait and related resources.

Field Description

ConditionedStatus
OAM common/v1.ConditionedStatus

(Members of ConditionedStatus are embedded into this type.)

Reconcile status of this metrics trait.

resources
[]QualifiedResourceRelation

Related resources affected by this metrics trait.

PortSpec

(Appears on:MetricsTraitSpec)

PortSpec defines an HTTP port and path combination.

Field	Description
`path` string	(Optional) The HTTP path for the related metrics endpoint. Defaults to `/metrics`.
`port` int	(Optional) The HTTP port for the related metrics trait. Defaults to `8080`.

QualifiedResourceRelation

(Appears on:MetricsTraitStatus, VerrazzanoHelidonWorkloadStatus)

QualifiedResourceRelation identifies a specific related resource.

Field	Description
`apiversion` string	API version of the related resource.
`kind` string	Kind of the related resource.
`name` string	Name of the related resource.
`namespace` string	Namespace of the related resource.
`role` string	Role of the related resource, for example, `Deployment`.

ServiceTemplate

(Appears on:VerrazzanoHelidonWorkloadSpec)

ServiceTemplate specifies the metadata and pod spec of a Helidon workload.

Field	Description
`metadata` Kubernetes meta/v1.ObjectMeta	(Optional) Metadata about a Helidon application. Refer to the Kubernetes API documentation for the fields of the `metadata` field.
`serviceSpec` Kubernetes core/v1.ServiceSpec	(Optional) The service spec of a Helidon application.

VerrazzanoCoherenceWorkloadSpec

(Appears on:VerrazzanoCoherenceWorkload)

VerrazzanoCoherenceWorkloadSpec wraps a Coherence resource.

Field	Description
`template` Kubernetes runtime.RawExtension	The metadata and spec for the underlying Coherence resource.

VerrazzanoCoherenceWorkloadStatus

(Appears on:VerrazzanoCoherenceWorkload)

VerrazzanoCoherenceWorkloadStatus defines the observed state of a Verrazzano Coherence workload.

Field	Description
`lastGeneration` string	The last generation of the Verrazzano Coherence workload that was reconciled.
`lastRestartVersion` string	The last value of the `verrazzano.io/restart-version` annotation.

VerrazzanoHelidonWorkloadSpec

(Appears on:VerrazzanoHelidonWorkload)

VerrazzanoHelidonWorkloadSpec wraps a Helidon application deployment and service.

Field	Description
`deploymentTemplate` DeploymentTemplate	An embedded Helidon application deployment.
`serviceTemplate` ServiceTemplate	An embedded Helidon application service.

VerrazzanoHelidonWorkloadStatus

(Appears on:VerrazzanoHelidonWorkload)

VerrazzanoHelidonWorkloadStatus defines the observed state of Verrazzano Helidon workload.

Field Description

ConditionedStatus
OAM common/v1.ConditionedStatus

(Members of ConditionedStatus are embedded into this type.)

Reconcile status of this Verrazzano Helidon workload.

resources
[]QualifiedResourceRelation

The resources managed by this Verrazzano Helidon workload.

VerrazzanoWebLogicWorkloadSpec

(Appears on:VerrazzanoWebLogicWorkload)

VerrazzanoWebLogicWorkloadSpec wraps a WebLogic resource. The WebLogic domain specified in the template must contain a spec field and it may include a metadata field.

Field	Description
`template` VerrazzanoWebLogicWorkloadTemplate	The metadata and spec for the underlying Domain resource.
`clusters` []VerrazzanoWebLogicWorkloadTemplate

VerrazzanoWebLogicWorkloadStatus

(Appears on:VerrazzanoWebLogicWorkload)

VerrazzanoWebLogicWorkloadStatus defines the observed state of a Verrazzano WebLogic workload.

Field	Description
`lastGeneration` string	The last generation of the Verrazzano WebLogic workload that was reconciled.
`lastRestartVersion` string	The last value of the `verrazzano.io/restart-version` annotation.
`lastLifecycleAction` string	The last value of the `verrazzano.io/lifecycle-action`.

VerrazzanoWebLogicWorkloadTemplate

(Appears on:VerrazzanoWebLogicWorkloadSpec)

Field Description

apiVersion
string

metadata
Kubernetes runtime.RawExtension

spec
Kubernetes runtime.RawExtension

-
[]byte

Raw is the underlying serialization of this object.

TODO: Determine how to detect ContentType and ContentEncoding of ‘Raw’ data.

-
Kubernetes runtime.Object

Object can hold a representation of this extension - useful for working with versioned structs.

Generated with gen-crd-api-reference-docs on git commit 238db2c3e.

Docs: Verrazzano Managed Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

clusters.verrazzano.io/v1alpha1

clusters.verrazzano.io/v1alpha1

Resource Types:

VerrazzanoManagedCluster

VerrazzanoManagedCluster

VerrazzanoManagedCluster specifies the Verrazzano Managed Cluster API.

Field Description

apiVersion
string clusters.verrazzano.io/v1alpha1

kind
string VerrazzanoManagedCluster

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
VerrazzanoManagedClusterSpec

The desired state of a Verrazzano Managed Cluster resource.

`caSecret` string	The name of a Secret that contains the CA certificate of the managed cluster. This is used to configure the admin cluster to scrape metrics from the Prometheus endpoint on the managed cluster. If Rancher is enabled on the admin cluster, this will be automatically populated by Verrazzano. Otherwise, if you disabled Rancher, see the pre-registration instructions for how to create this Secret.
`description` string	(Optional) The description of the managed cluster.
`managedClusterManifestSecret` string	(Optional) The name of the Secret containing the generated YAML manifest file to be applied by the user to the managed cluster. This field is managed by a Verrazzano Kubernetes operator.
`serviceAccount` string	(Optional) The name of the ServiceAccount that was generated for the managed cluster. This field is managed by a Verrazzano Kubernetes operator.

status
VerrazzanoManagedClusterStatus

The observed state of a Verrazzano Managed Cluster resource.

ArgoCDRegistration

(Appears on:VerrazzanoManagedClusterStatus)

ArgoCDRegistration defines the Argo CD registration state for a managed cluster.

Field	Description
`status` ArgoCDRegistrationStatus	The status of the ArgoCD registration.
`lastSetTimestamp` Kubernetes meta/v1.Time	(Optional) The timestamp of last status set.
`message` string	(Optional) Supporting message related to the Argo CD registration status.

ArgoCDRegistrationStatus (`string` alias)

(Appears on:ArgoCDRegistration)

ArgoCDRegistrationStatus identifies the status of an Argo CD registration.

Value	Description
"Completed"
"Failed"
"PendingRancherClusterRegistration"

Condition

(Appears on:VerrazzanoManagedClusterStatus)

Condition describes a condition that occurred on the Verrazzano Managed Cluster.

Field	Description
`lastTransitionTime` Kubernetes meta/v1.Time	(Optional) Last time the condition transitioned from one status to another.
`message` string	(Optional) A message with details about the last transition.
`status` Kubernetes core/v1.ConditionStatus	Status of the condition: one of `True`, `False`, or `Unknown`.
`type` ConditionType	The condition of the multicluster resource which can be checked with a `kubectl wait` command. Condition values are case-sensitive and formatted as follows: `Ready`: the VerrazzanoManagedCluster is ready to be used and all resources needed have been generated.

ConditionType (`string` alias)

(Appears on:Condition)

ConditionType identifies the condition of the Verrazzano Managed Cluster which can be checked with kubectl wait.

Value	Description
"ManagedCARetrieved"	ManagedCARetrieved = true means that the managed cluster CA cert has been retrieved and populated. This is done by the VMC controller via the Rancher API proxy for the managed cluster.
"ManifestPushed"	ConditionManifestPushed = true means the the agent and registration secrets have been successfully transferred to the managed cluster on a multicluster install
"Ready"	Ready = true means the VMC is ready to be used and all resources needed have been generated

RancherRegistration

(Appears on:VerrazzanoManagedClusterStatus)

RancherRegistration defines the Rancher registration state for a managed cluster.

Field	Description
`clusterID` string	The Rancher cluster ID for this cluster.
`message` string	(Optional) A supporting message related to the Rancher registration status.
`status` RancherRegistrationStatus	The status of the Rancher registration.

RancherRegistrationStatus (`string` alias)

(Appears on:RancherRegistration)

RancherRegistrationStatus identifies the status of a Rancher registration.

Value	Description
"DeleteFailed"
"Completed"
"Failed"

StateType (`string` alias)

(Appears on:VerrazzanoManagedClusterStatus)

StateType identifies the state of the Verrazzano Managed Cluster.

Value	Description
"Active"
"Inactive"
"Pending"

VerrazzanoManagedClusterSpec

(Appears on:VerrazzanoManagedCluster)

VerrazzanoManagedClusterSpec defines the desired state of a Verrazzano Managed Cluster.

Field	Description
`caSecret` string	The name of a Secret that contains the CA certificate of the managed cluster. This is used to configure the admin cluster to scrape metrics from the Prometheus endpoint on the managed cluster. If Rancher is enabled on the admin cluster, this will be automatically populated by Verrazzano. Otherwise, if you disabled Rancher, see the pre-registration instructions for how to create this Secret.
`description` string	(Optional) The description of the managed cluster.
`managedClusterManifestSecret` string	(Optional) The name of the Secret containing the generated YAML manifest file to be applied by the user to the managed cluster. This field is managed by a Verrazzano Kubernetes operator.
`serviceAccount` string	(Optional) The name of the ServiceAccount that was generated for the managed cluster. This field is managed by a Verrazzano Kubernetes operator.

VerrazzanoManagedClusterStatus

(Appears on:VerrazzanoManagedCluster)

VerrazzanoManagedClusterStatus defines the observed state of a Verrazzano Managed Cluster.

Field	Description
`apiUrl` string	The Verrazzano API server URL for this managed cluster.
`conditions` []Condition	The current state of this managed cluster.
`lastAgentConnectTime` Kubernetes meta/v1.Time	The last time the agent from this managed cluster connected to the admin cluster.
`prometheusHost` string	The Prometheus host for this managed cluster.
`thanosQueryStore` string	The Thanos Query Store API host name for this managed cluster.
`rancherRegistration` RancherRegistration	The state of Rancher registration for this managed cluster.
`argoCDRegistration` ArgoCDRegistration	The state of ArgoCD registration for this managed cluster.
`state` StateType	The state of this managed cluster.

Generated with gen-crd-api-reference-docs on git commit 238db2c3e.

Docs: Verrazzano v1beta1 APIs

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

install.verrazzano.io/v1beta1

install.verrazzano.io/v1beta1

Resource Types:

Verrazzano

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)

Deprecated. Acme identifies the LetsEncrypt cert issuer.

Field	Description
`emailAddress` string	(Optional) Email address of the user.
`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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(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.

ArgoCDComponent

(Appears on:ComponentSpec)

ArgoCDComponent specifies the Argo CD configuration.

Field Description

enabled
bool

(Optional)

If true, then Argo CD will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

AuthProxyComponent

(Appears on:ComponentSpec)

AuthProxyComponent specifies the AuthProxy configuration.

Field Description

enabled
bool

(Optional)

If true, then AuthProxy will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

CA

(Appears on:Certificate)

CA - Deprecated. Identifies the Certificate Authority cert issuer.

Field	Description
`clusterResourceNamespace` string	The secret namespace.
`secretName` string	The secret name.

CAIssuer

(Appears on:ClusterIssuerComponent, IssuerConfig)

CAIssuer Identifies the configuration used for the Certificate Authority issuer

Field	Description
`secretName` string	The secret name.

CertManagerComponent

(Appears on:ComponentSpec)

CertManagerComponent specifies the cert-manager configuration.

Field	Description
`certificate` Certificate	(Optional) Deprecated. Use the ClusterIssuerComponent to configure the Verrazzano ClusterIssuer instead
`enabled` bool	(Optional) If true, then cert-manager will be installed.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.

CertManagerWebhookOCIComponent

(Appears on:ComponentSpec)

CertManagerWebhookOCIComponent configures the CertManager OCI DNS solver webhook; the webhook is required for LetsEncrypt Certificates using OCI DNS

Field Description

enabled
bool

(Optional)

Enabled will deploy the webhook if true, or if the LetsEncrypt issuer is configured with OCI DNS

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

Certificate

(Appears on:CertManagerComponent)

Certificate - Deprecated. Represents the type of cert issuer for an installation.

Field	Description
`acme` Acme	(Optional) The LetsEncrypt configuration. Either `acme` or `ca` must be specified.
`ca` CA	(Optional) The LetsEncrypt configuration. Either `acme` or `ca` must be specified.

ClusterAPIComponent

(Appears on:ComponentSpec)

ClusterAPIComponent specifies the Cluster API configuration.

Field Description

enabled
bool

(Optional)

If true, then Cluster API Providers will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

ClusterAgentComponent

(Appears on:ComponentSpec)

ClusterAgentComponent configures the Cluster Agent

Field Description

enabled
bool

(Optional)

If true, then Cluster Agent will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

ClusterIssuerComponent

(Appears on:ComponentSpec)

ClusterIssuerComponent configures the Verrazzano ClusterIssuer

Field	Description
`enabled` bool	(Optional) Enabled indicates that Verrazzano ClusterIssuer shall be configured
`clusterResourceNamespace` string	The clusterResourceNamespace configured for the Verrazzano Cert-Manager instance; if an externally-managed Cert-Manager is being used with a non-default location, this should point to the clusterResourceNamespace used by that installation. See the Cert-Manager documentation details on this namespace.
`letsEncrypt` LetsEncryptACMEIssuer	(Inlined from IssuerConfig.) (Optional) The LetsEncrypt issuer configuration.
`ca` CAIssuer	(Inlined from IssuerConfig.) (Optional) The certificate configuration.

ClusterOperatorComponent

(Appears on:ComponentSpec)

ClusterOperatorComponent specifies the Cluster Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then the Cluster Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

CoherenceOperatorComponent

(Appears on:ComponentSpec)

CoherenceOperatorComponent specifies the Coherence Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then the Coherence Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

CompStateType (`string` alias)

(Appears on:ComponentStatusDetails)

CompStateType identifies the state of a component.

Value	Description
"Disabled"	CompStateDisabled is the state for when a component is not currently installed
"Error"	CompStateError is the state when a Verrazzano resource has experienced an error that may leave it in an unstable state
"Failed"	CompStateFailed is the state when an install/uninstall/upgrade has failed
"Installing"	CompStateInstalling is the state when an install is in progress
"PreInstalling"	CompStatePreInstalling is the state when an install is about to be started
"Ready"	CompStateReady is the state when a Verrazzano resource can perform an uninstall or upgrade
"Uninstalled"	CompStateUninstalled is the state when a component has been uninstalled
"Uninstalling"	CompStateUninstalling is the state when an uninstall is in progress
"Upgrading"	CompStateUpgrading is the state when an upgrade is in progress

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.
`clusterAPI` ClusterAPIComponent	(Optional) The ClusterAPI component configuration.
`clusterAgent` ClusterAgentComponent	(Optional) The ClusterAgent configuration.
`clusterIssuer` ClusterIssuerComponent	(Optional) ClusterIssuer defines the Cert-Manager ClusterIssuer configuration for Verrazzano
`certManager` CertManagerComponent	(Optional) The Verrazzano-managed Cert-Manager component configuration; note that this is mutually exclusive of the ExternalCertManager component
`certManagerWebhookOCI` CertManagerWebhookOCIComponent	(Optional) CertManagerWebhookOCI configures the Verrazzano OCI DNS webhook plugin for Cert-Manager
`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.
`fluentOperator` FluentOperatorComponent	(Optional) The FluentOperator component configuration.
`fluentbitOpensearchOutput` FluentbitOpensearchOutputComponent	(Optional) The FluentbitOpensearchOutput 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` PrometheusAdapterComponent	(Optional) The Prometheus Adapter component configuration.
`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.
`thanos` ThanosComponent	(Optional) The Thanos 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.

ComponentValidator

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	Human readable message indicating details about the last transition.
`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.

Value	Description
"InstallComplete"	CondInstallComplete means the install job has completed its execution successfully
"InstallFailed"	CondInstallFailed means the install job has failed during execution.
"InstallStarted"	CondInstallStarted means an install is in progress.
"PreInstall"	CondPreInstall means an install about to start.
"UninstallComplete"	CondUninstallComplete means the uninstall job has completed its execution successfully
"UninstallFailed"	CondUninstallFailed means the uninstall job has failed during execution.
"UninstallStarted"	CondUninstallStarted means an uninstall is in progress.
"UpgradeComplete"	CondUpgradeComplete means the upgrade has completed successfully
"UpgradeFailed"	CondUpgradeFailed means the upgrade has failed during execution.
"UpgradePaused"	CondUpgradePaused means that an upgrade has been paused awaiting a VZ version update.
"UpgradeStarted"	CondUpgradeStarted means that an upgrade has been started.

ConsoleComponent

(Appears on:ComponentSpec)

ConsoleComponent specifies the Verrazzano Console configuration.

Field Description

enabled
bool

(Optional)

If true, then Verrazzano Console will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

DNSComponent

(Appears on:ComponentSpec)

DNSComponent specifies the DNS configuration.

Field	Description
`external` External	(Optional) External DNS configuration.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`oci` OCI	(Optional) Oracle Cloud Infrastructure DNS configuration.
`wildcard` Wildcard	(Optional) Wildcard DNS configuration. This is the default with a domain of nip.io.

DNSConfig

Field	Description
`external` External	(Optional) External DNS configuration.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`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, DNSConfig)

External DNS type.

Field	Description
`suffix` string	The suffix for DNS names.

FluentOperatorComponent

(Appears on:ComponentSpec)

FluentOperatorComponent specifies the Fluent Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then the Fluent Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

FluentbitOpensearchOutputComponent

(Appears on:ComponentSpec)

Field Description

enabled
bool

(Optional)

If true, then the FluentbitOpensearchOutput will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`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`.
`smtp` VMO /vmcontroller/v1.SMTPInfo	(Optional) The SMTP notification settings.

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`.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`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.

Value	Description
"LoadBalancer"	LoadBalancer is an ingress type of LoadBalancer. This is the default value.
"NodePort"	NodePort is an ingress type of NodePort.

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.
`thanosQueryUrl` string	The Thanos Query URL for this Verrazzano installation. The Thanos Query ingress gets forwarded to the Thanos Query Frontend service.

IssuerConfig

IssuerConfig identifies the configuration for the Verrazzano ClusterIssuer. Only one value may be set.

Field	Description
`letsEncrypt` LetsEncryptACMEIssuer	(Optional) The LetsEncrypt issuer configuration.
`ca` CAIssuer	(Optional) The certificate configuration.

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`.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.

JaegerOperatorComponent

(Appears on:ComponentSpec)

JaegerOperatorComponent specifies the Jaeger Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then Jaeger Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

KeycloakComponent

(Appears on:ComponentSpec)

KeycloakComponent specifies the Keycloak configuration.

Field	Description
`enabled` bool	(Optional) If true, then Keycloak will be installed.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

LetsEncryptACMEIssuer

(Appears on:ClusterIssuerComponent, IssuerConfig)

LetsEncryptAcmeIssuer identifies the configuration used for the LetsEncrypt cert issuer

Field	Description
`emailAddress` string	(Optional) Email address of the user.
`environment` string	(Optional) Environment can be “staging” or “production”

MySQLComponent

(Appears on:KeycloakComponent)

MySQLComponent specifies the MySQL configuration.

Field Description

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

OAMComponent

(Appears on:ComponentSpec)

OAMComponent specifies the OAM configuration.

Field Description

enabled
bool

(Optional)

If true, then OAM will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

OCI

(Appears on:DNSComponent, DNSConfig)

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:ApplicationOperatorComponent, ArgoCDComponent, AuthProxyComponent, CertManagerComponent, CertManagerWebhookOCIComponent, ClusterAPIComponent, ClusterAgentComponent, ClusterOperatorComponent, CoherenceOperatorComponent, ConsoleComponent, DNSComponent, DNSConfig, FluentOperatorComponent, FluentbitOpensearchOutputComponent, FluentdComponent, IngressNginxComponent, InstallOverrides, IstioComponent, JaegerOperatorComponent, KeycloakComponent, KialiComponent, KubeStateMetricsComponent, MySQLComponent, MySQLOperatorComponent, OAMComponent, PrometheusAdapterComponent, PrometheusNodeExporterComponent, PrometheusOperatorComponent, PrometheusPushgatewayComponent, RancherBackupComponent, RancherComponent, ThanosComponent, VeleroComponent, VerrazzanoComponent, WebLogicOperatorComponent)

Overrides identifies overrides for a component.

Field	Description
`configMapRef` Kubernetes core/v1.ConfigMapKeySelector	(Optional) Selector for ConfigMap containing override data. For sample usage, see ConfigMapRef.
`secretRef` Kubernetes core/v1.SecretKeySelector	(Optional) Selector for Secret containing override data. For sample usage, see SecretRef.
`values` Kubernetes apiextensions/v1.JSON	(Optional) Configure overrides using inline YAML. For sample usage, see Values.

ProfileType (`string` alias)

(Appears on:VerrazzanoSpec)

ProfileType is the type of installation profile.

Value	Description
"dev"	Dev identifies the development install profile
"managed-cluster"	ManagedCluster identifies the production managed-cluster install profile
"none"	None identifies a profile with all components disabled
"prod"	Prod identifies the production install profile

PrometheusAdapterComponent

(Appears on:ComponentSpec)

PrometheusAdapterComponent specifies the Prometheus Adapter configuration.

Field Description

enabled
bool

(Optional)

If true, then Prometheus Adaptor will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

PrometheusOperatorComponent

(Appears on:ComponentSpec)

PrometheusOperatorComponent specifies the Prometheus Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then Prometheus Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

PrometheusPushgatewayComponent

(Appears on:ComponentSpec)

PrometheusPushgatewayComponent specifies the Prometheus Pushgateway configuration.

Field Description

enabled
bool

(Optional)

If true, then Prometheus Pushgateway will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

ProviderType (`string` alias)

(Appears on:Acme)

ProviderType identifies Acme provider type.

Value	Description
"LetsEncrypt"	LetsEncrypt is a Let’s Encrypt provider

RancherBackupComponent

(Appears on:ComponentSpec)

RancherBackupComponent specifies the rancherBackup configuration.

Field Description

enabled
bool

(Optional)

If true, then rancherBackup will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

RancherComponent

(Appears on:ComponentSpec)

RancherComponent specifies the Rancher configuration.

Field	Description
`enabled` bool	(Optional) If true, then Rancher will be installed.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`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.

ThanosComponent

(Appears on:ComponentSpec)

ThanosComponent specifies the Thanos configuration.

Field Description

enabled
bool

(Optional)

If true, then Thanos will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

VeleroComponent

(Appears on:ComponentSpec)

VeleroComponent specifies the Velero configuration.

Field Description

enabled
bool

(Optional)

If true, then Velero will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

VerrazzanoComponent

(Appears on:ComponentSpec)

VerrazzanoComponent specifies the Verrazzano configuration.

Field Description

enabled
bool

(Optional)

If true, then Verrazzano will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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

Metadata about the PersistentVolumeClaimSpec template.

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.

Value	Description
"Failed"	VzStateFailed is the state when an install/uninstall/upgrade has failed
"Paused"	VzStatePaused is the state when an upgrade is paused due to version mismatch
"Ready"	VzStateReady is the state when a Verrazzano resource can perform an uninstall or upgrade
"Reconciling"	VzStateReconciling is the state when a resource is in progress reconciling
"Uninstalling"	VzStateUninstalling is the state when an uninstall is in progress
"Upgrading"	VzStateUpgrading is the state when an upgrade is in progress

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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

Wildcard

(Appears on:DNSComponent, DNSConfig)

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 on git commit 238db2c3e.

Docs: Verrazzano v1alpha1 APIs

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

install.verrazzano.io/v1alpha1

install.verrazzano.io/v1alpha1

Resource Types:

Verrazzano

Verrazzano

Verrazzano specifies the Verrazzano API.

Field Description

apiVersion
string install.verrazzano.io/v1alpha1

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)

Deprecated. Acme identifies the LetsEncrypt cert issuer.

Field	Description
`emailAddress` string	(Optional) Email address of the user.
`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 Application Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(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.

ArgoCDComponent

(Appears on:ComponentSpec)

ArgoCDComponent specifies the Argo CD configuration.

Field Description

enabled
bool

(Optional)

If true, then Argo CD will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

AuthProxyComponent

(Appears on:ComponentSpec)

AuthProxyComponent specifies the AuthProxy configuration.

Field	Description
`enabled` bool	(Optional) If true, then AuthProxy will be installed.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`kubernetes` AuthProxyKubernetesSection	(Optional) The Kubernetes resources that can be configured for AuthProxy.

AuthProxyKubernetesSection

(Appears on:AuthProxyComponent)

AuthProxyKubernetesSection specifies the Kubernetes resources that can be customized for AuthProxy.

Field Description

replicas
uint32

(Inlined from CommonKubernetesSpec.)

(Optional)

Specifies the number of pod instances to run.

affinity
Kubernetes core/v1.Affinity

(Inlined from CommonKubernetesSpec.)

(Optional)

Specifies the group of affinity scheduling rules.

CA

(Appears on:Certificate)

CA - Deprecated. Identifies the Certificate Authority cert issuer.

Field	Description
`clusterResourceNamespace` string	The secret namespace.
`secretName` string	The secret name.

CAIssuer

(Appears on:ClusterIssuerComponent, IssuerConfig)

CAIssuer Identifies the configuration used for the Certificate Authority issuer

Field	Description
`secretName` string	The secret name.

CertManagerComponent

(Appears on:ComponentSpec)

CertManagerComponent specifies the cert-manager configuration.

Field	Description
`certificate` Certificate	(Optional) Deprecated. Use the ClusterIssuerComponent to configure the Verrazzano ClusterIssuer instead
`enabled` bool	(Optional) If true, then cert-manager will be installed.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.

CertManagerOCIDNSWebhookSolver

CertManagerOCIDNSWebhookSolver specifies installation overrides for the CertManager OCI DNS solver webhook; the webhook is automatically installed when OCI DNS is configured for the Verrazzano installation

Field Description

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

CertManagerWebhookOCIComponent

(Appears on:ComponentSpec)

CertManagerWebhookOCIComponent configures the CertManager OCI DNS solver webhook; the webhook is required for LetsEncrypt Certificates using OCI DNS

Field Description

enabled
bool

(Optional)

Enabled will deploy the webhook if true, or if the LetsEncrypt issuer is configured with OCI DNS

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

Certificate

(Appears on:CertManagerComponent)

Certificate - Deprecated. Represents the type of cert issuer for an installation.

Field	Description
`acme` Acme	(Optional) The LetsEncrypt configuration. Either `acme` or `ca` must be specified.
`ca` CA	(Optional) The LetsEncrypt configuration. Either `acme` or `ca` must be specified.

ClusterAPIComponent

(Appears on:ComponentSpec)

ClusterAPIComponent specifies the Cluster API configuration.

Field Description

enabled
bool

(Optional)

If true, then Cluster API Providers will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

ClusterAgentComponent

(Appears on:ComponentSpec)

ClusterAgentComponent configures the Cluster Agent

Field Description

enabled
bool

(Optional)

If true, then Cluster Agent will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

ClusterIssuerComponent

(Appears on:ComponentSpec)

ClusterIssuerComponent configures the Verrazzano ClusterIssuer

Field	Description
`enabled` bool	(Optional) Enabled indicates that Verrazzano ClusterIssuer shall be configured
`clusterResourceNamespace` string	The clusterResourceNamespace configured for the Verrazzano Cert-Manager instance; if an externally-managed Cert-Manager is being used with a non-default location, this should point to the clusterResourceNamespace used by that installation. See the Cert-Manager documentation details on this namespace.
`letsEncrypt` LetsEncryptACMEIssuer	(Inlined from IssuerConfig.) (Optional) The certificate configuration.
`ca` CAIssuer	(Inlined from IssuerConfig.) (Optional) The certificate configuration.

ClusterOperatorComponent

(Appears on:ComponentSpec)

ClusterOperatorComponent specifies the Cluster Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then the Cluster Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

CoherenceOperatorComponent

(Appears on:ComponentSpec)

CoherenceOperatorComponent specifies the Coherence Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then Coherence Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

CommonKubernetesSpec

Kubernetes resources that are common to a subgroup of components.

Field	Description
`replicas` uint32	(Optional) Specifies the number of pod instances to run.
`affinity` Kubernetes core/v1.Affinity	(Optional) Specifies the group of affinity scheduling rules.

CompStateType (`string` alias)

(Appears on:ComponentStatusDetails)

CompStateType identifies the state of a component.

Value	Description
"Disabled"	CompStateDisabled is the state for when a component is not currently installed
"Error"	CompStateError is the state when a Verrazzano resource has experienced an error that may leave it in an unstable state
"Failed"	CompStateFailed is the state when an install/uninstall/upgrade has failed
"Installing"	CompStateInstalling is the state when an install is in progress
"PreInstalling"	CompStatePreInstalling is the state when an install is about to be started
"Ready"	CompStateReady is the state when a Verrazzano resource can perform an uninstall or upgrade
"Uninstalled"	CompStateUninstalled is the state when a component has been uninstalled
"Uninstalling"	CompStateUninstalling is the state when an uninstall is in progress
"Upgrading"	CompStateUpgrading is the state when an upgrade is in progress

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.
`clusterAPI` ClusterAPIComponent	(Optional) The ClusterAPI component configuration.
`clusterAgent` ClusterAgentComponent	(Optional) The ClusterAgent configuration.
`clusterIssuer` ClusterIssuerComponent	(Optional) ClusterIssuer defines the Cert-Manager ClusterIssuer configuration for Verrazzano
`certManager` CertManagerComponent	(Optional) The Verrazzano-managed Cert-Manager component configuration; note that this is mutually exclusive of the ExternalCertManager component
`certManagerWebhookOCI` CertManagerWebhookOCIComponent	(Optional) CertManagerWebhookOCI configures the Verrazzano OCI DNS webhook plugin for Cert-Manager
`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.
`elasticsearch` ElasticsearchComponent	(Optional) The Elasticsearch component configuration.
`fluentd` FluentdComponent	(Optional) The Fluentd component configuration.
`fluentOperator` FluentOperatorComponent	(Optional) The FluentOperator component configuration.
`fluentbitOpensearchOutput` FluentbitOpensearchOutputComponent	(Optional) The FluentbitOpensearchOutput component configuration.
`grafana` GrafanaComponent	(Optional) The Grafana component configuration.
`ingress` IngressNginxComponent	(Optional) The ingress NGINX component configuration.
`istio` IstioComponent	(Optional) The Istio component configuration.
`jaegerOperator` JaegerOperatorComponent	(Optional) The Jaeger Operator component configuration.
`kiali` KialiComponent	(Optional) The Kiali component configuration.
`kibana` KibanaComponent	(Optional) The Kibana component configuration.
`keycloak` KeycloakComponent	(Optional) The Keycloak 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.
`prometheus` PrometheusComponent	(Optional) The Prometheus component configuration.
`prometheusAdapter` PrometheusAdapterComponent	(Optional) The Prometheus Adapter component configuration.
`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.
`thanos` ThanosComponent	(Optional) The Thanos 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/v1alpha1.ComponentStatusDetails` alias)

(Appears on:VerrazzanoStatus)

ComponentStatusMap is a map of components status details.

ComponentValidator

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	Human readable message indicating details about the last transition.
`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.

Value	Description
"InstallComplete"	CondInstallComplete means the install job has completed its execution successfully
"InstallFailed"	CondInstallFailed means the install job has failed during execution.
"InstallStarted"	CondInstallStarted means an install is in progress.
"PreInstall"	CondPreInstall means an install about to start.
"UninstallComplete"	CondUninstallComplete means the uninstall job has completed its execution successfully
"UninstallFailed"	CondUninstallFailed means the uninstall job has failed during execution.
"UninstallStarted"	CondUninstallStarted means an uninstall is in progress.
"UpgradeComplete"	CondUpgradeComplete means the upgrade has completed successfully
"UpgradeFailed"	CondUpgradeFailed means the upgrade has failed during execution.
"UpgradePaused"	CondUpgradePaused means that an upgrade has been paused awaiting a VZ version update.
"UpgradeStarted"	CondUpgradeStarted means that an upgrade has been started.

ConsoleComponent

(Appears on:ComponentSpec)

ConsoleComponent specifies the Verrazzano Console configuration.

Field Description

enabled
bool

(Optional)

If true, then the Verrazzano Console will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

DNSComponent

(Appears on:ComponentSpec)

DNSComponent specifies the DNS configuration.

Field	Description
`external` External	(Optional) External DNS configuration.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`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.

ElasticsearchComponent

(Appears on:ComponentSpec)

ElasticsearchComponent specifies the Elasticsearch configuration.

Field	Description
`enabled` bool	(Optional) If true, then OpenSearch will be installed.
`installArgs` []InstallArgs	(Optional) A list of values to use during the OpenSearch installation. Each argument is specified as either a `name/value` or `name/valueList` pair. For sample usage, see Customize OpenSearch.
`nodes` []OpenSearchNode	(Optional) A list of OpenSearch node groups.
`policies` []VMO /vmcontroller/v1.IndexManagementPolicy	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.

External

(Appears on:DNSComponent)

External DNS type.

Field	Description
`suffix` string	The suffix for DNS names.

FluentOperatorComponent

(Appears on:ComponentSpec)

FluentOperatorComponent specifies the Fluent Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then the Fluent Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

FluentbitOpensearchOutputComponent

(Appears on:ComponentSpec)

Field Description

enabled
bool

(Optional)

If true, then the FluentbitOpensearchOutput will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

FluentdComponent

(Appears on:ComponentSpec)

FluentdComponent specifies the Fluentd configuration.

Field	Description
`elasticsearchSecret` 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.
`elasticsearchURL` 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.
`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.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`oci` OciLoggingConfiguration	(Optional) The Oracle Cloud Infrastructure Logging configuration.

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`.
`smtp` VMO /vmcontroller/v1.SMTPInfo	(Optional) The SMTP notification settings.

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`.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`nginxInstallArgs` []InstallArgs	(Optional) Arguments for installing NGINX.
`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 NGINXInstallArgs. For sample usage, see External Load Balancers.

IngressType (`string` alias)

(Appears on:IngressNginxComponent, IstioIngressSection)

IngressType is the type of ingress.

Value	Description
"LoadBalancer"	LoadBalancer is an ingress type of LoadBalancer. This is the default value.
"NodePort"	NodePort is an ingress type of NodePort.

InstallArgs

(Appears on:ElasticsearchComponent, IngressNginxComponent, IstioComponent, KeycloakComponent, MySQLComponent, VerrazzanoComponent)

InstallArgs identifies a name/value or name/value list needed for the install. Value and ValueList cannot both be specified.

Field	Description
`name` string	Name of the install argument.
`value` string	(Optional) Value for the named install argument.
`setString` bool	(Optional) If the value is a literal string.
`valueList` []string	(Optional) List of values for the named install argument.

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 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.
`elasticUrl` string	The OpenSearch 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.
`kibanaUrl` string	The OpenSearch Dashboards URL for this Verrazzano installation.
`prometheusUrl` string	The Prometheus URL for this Verrazzano installation.
`rancherUrl` string	The Rancher URL for this Verrazzano installation.
`thanosQueryUrl` string	The Thanos Query URL for this Verrazzano installation. The Thanos Query ingress gets forwarded to the Thanos Query Frontend service.

IssuerConfig

IssuerConfig identifies the configuration for the Verrazzano ClusterIssuer. Only one value may be set.

Field	Description
`letsEncrypt` LetsEncryptACMEIssuer	(Optional) The certificate configuration.
`ca` CAIssuer	(Optional) The certificate configuration.

IstioComponent

(Appears on:ComponentSpec)

IstioComponent specifies the Istio configuration.

Field	Description
`egress` IstioEgressSection	(Optional) The Istio egress gateway configuration.
`enabled` bool	(Optional) If true, then Istio will be installed.
`ingress` IstioIngressSection	(Optional) The Istio ingress gateway configuration.
`injectionEnabled` bool	(Optional) Istio sidecar injection enabled for installed components. Default is `true`.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`istioInstallArgs` []InstallArgs	(Optional) Arguments for installing Istio.

IstioEgressSection

(Appears on:IstioComponent)

IstioEgressSection specifies the specific configuration options available for the Istio egress gateways.

Field	Description
`kubernetes` IstioKubernetesSection	(Optional) The Kubernetes resources that can be configured for an Istio egress gateway.

IstioIngressSection

(Appears on:IstioComponent)

IstioIngressSection specifies the specific configuration options available for the Istio ingress gateways.

Field	Description
`type` IngressType	(Optional) The Istio ingress type. Valid values are `LoadBalancer` and `NodePort`. The default value is `LoadBalancer`. If the Istio ingress type is `NodePort`, then a valid and accessible IP address must be specified using the `gateways.istio-ingressgateway.externalIPs` key in IstioInstallArgs. For sample usage, see External Load Balancers.
`ports` []Kubernetes core/v1.ServicePort	(Optional) The list port configurations used by the Istio ingress.
`kubernetes` IstioKubernetesSection	(Optional) The Kubernetes resources that can be configured for an Istio ingress gateway.

IstioKubernetesSection

(Appears on:IstioEgressSection, IstioIngressSection)

IstioKubernetesSection specifies the Kubernetes resources that can be customized for Istio.

Field Description

replicas
uint32

(Inlined from CommonKubernetesSpec.)

(Optional)

Specifies the number of pod instances to run.

affinity
Kubernetes core/v1.Affinity

(Inlined from CommonKubernetesSpec.)

(Optional)

Specifies the group of affinity scheduling rules.

JaegerOperatorComponent

(Appears on:ComponentSpec)

JaegerOperatorComponent specifies the Jaeger Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then Jaeger Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

KeycloakComponent

(Appears on:ComponentSpec)

KeycloakComponent specifies the Keycloak configuration.

Field	Description
`enabled` bool	(Optional) If true, then Keycloak will be installed.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`keycloakInstallArgs` []InstallArgs	(Optional) Arguments for installing Keycloak.
`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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

KibanaComponent

(Appears on:ComponentSpec)

KibanaComponent specifies the Kibana 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

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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

LetsEncryptACMEIssuer

(Appears on:ClusterIssuerComponent, IssuerConfig)

LetsEncryptACMEIssuer identifies the configuration used for the LetsEncrypt cert issuer

Field	Description
`emailAddress` string	(Optional) Email address of the user.
`environment` string	(Optional) Environment can be “staging” or “production”

MySQLComponent

(Appears on:KeycloakComponent)

MySQLComponent specifies the MySQL configuration.

Field	Description
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`mysqlInstallArgs` []InstallArgs	(Optional) Arguments for installing MySQL.
`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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

OAMComponent

(Appears on:ComponentSpec)

OAMComponent specifies the OAM configuration.

Field Description

enabled
bool

(Optional)

If true, then OAM will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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.

OpenSearchNode

(Appears on:ElasticsearchComponent)

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:ApplicationOperatorComponent, ArgoCDComponent, AuthProxyComponent, CertManagerComponent, CertManagerOCIDNSWebhookSolver, CertManagerWebhookOCIComponent, ClusterAPIComponent, ClusterAgentComponent, ClusterOperatorComponent, CoherenceOperatorComponent, ConsoleComponent, DNSComponent, FluentOperatorComponent, FluentbitOpensearchOutputComponent, FluentdComponent, IngressNginxComponent, InstallOverrides, IstioComponent, JaegerOperatorComponent, KeycloakComponent, KialiComponent, KubeStateMetricsComponent, MySQLComponent, MySQLOperatorComponent, OAMComponent, PrometheusAdapterComponent, PrometheusNodeExporterComponent, PrometheusOperatorComponent, PrometheusPushgatewayComponent, RancherBackupComponent, RancherComponent, ThanosComponent, VeleroComponent, VerrazzanoComponent, WebLogicOperatorComponent)

Overrides identifies overrides for a component.

Field	Description
`configMapRef` Kubernetes core/v1.ConfigMapKeySelector	(Optional) Selector for ConfigMap containing override data. For sample usage, see ConfigMapRef.
`secretRef` Kubernetes core/v1.SecretKeySelector	(Optional) Selector for Secret containing override data. For sample usage, see SecretRef.
`values` Kubernetes apiextensions/v1.JSON	(Optional) Configure overrides using inline YAML. For sample usage, see Values.

ProfileType (`string` alias)

(Appears on:VerrazzanoSpec)

ProfileType is the type of installation profile.

Value	Description
"dev"	Dev identifies the development install profile
"managed-cluster"	ManagedCluster identifies the production managed-cluster install profile
"none"	None identifies a profile with all components disabled
"prod"	Prod identifies the production install profile

PrometheusAdapterComponent

(Appears on:ComponentSpec)

PrometheusAdapterComponent specifies the Prometheus Adapter configuration.

Field Description

enabled
bool

(Optional)

If true, then Prometheus Adaptor will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

PrometheusOperatorComponent

(Appears on:ComponentSpec)

PrometheusOperatorComponent specifies the Prometheus Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then Prometheus Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

PrometheusPushgatewayComponent

(Appears on:ComponentSpec)

PrometheusPushgatewayComponent specifies the Prometheus Pushgateway configuration.

Field Description

enabled
bool

(Optional)

If true, then Prometheus Pushgateway will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

ProviderType (`string` alias)

(Appears on:Acme)

ProviderType identifies Acme provider type.

Value	Description
"LetsEncrypt"	LetsEncrypt is a Let’s Encrypt provider

RancherBackupComponent

(Appears on:ComponentSpec)

RancherBackupComponent specifies the rancherBackup configuration.

Field Description

enabled
bool

(Optional)

If true, then rancherBackup will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

RancherComponent

(Appears on:ComponentSpec)

RancherComponent specifies the Rancher configuration.

Field	Description
`enabled` bool	(Optional) If true, then Rancher will be installed.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.
`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.

ThanosComponent

(Appears on:ComponentSpec)

ThanosComponent specifies the Thanos configuration.

Field Description

enabled
bool

(Optional)

If true, then Thanos will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

VeleroComponent

(Appears on:ComponentSpec)

VeleroComponent specifies the Velero configuration.

Field Description

enabled
bool

(Optional)

If true, then Velero will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

VerrazzanoComponent

(Appears on:ComponentSpec)

VerrazzanoComponent specifies the Verrazzano configuration.

Field	Description
`enabled` bool	(Optional) If true, then Verrazzano will be installed.
`installArgs` []InstallArgs	(Optional) Arguments for installing Verrazzano.
`monitorChanges` bool	(Inlined from InstallOverrides.) (Optional) If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.
`overrides` []Overrides	(Inlined from InstallOverrides.) (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.

VerrazzanoSpec

(Appears on:Verrazzano)

VerrazzanoSpec defines the desired state of a 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 information.
`version` string	The version of Verrazzano that is installed.

VolumeClaimSpecTemplate

(Appears on:VerrazzanoSpec)

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

Field Description

metadata
Kubernetes meta/v1.ObjectMeta

Metadata about the PersistentVolumeClaimSpec template.

Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Kubernetes core/v1.PersistentVolumeClaimSpec

`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.

Value	Description
"Failed"	VzStateFailed is the state when an install/uninstall/upgrade has failed
"Paused"	VzStatePaused is the state when an upgrade is paused due to version mismatch
"Ready"	VzStateReady is the state when a Verrazzano resource can perform an uninstall or upgrade
"Reconciling"	VzStateReconciling is the state when a resource is in progress reconciling
"Uninstalling"	VzStateUninstalling is the state when an uninstall is in progress
"Upgrading"	VzStateUpgrading is the state when an upgrade is in progress

WebLogicOperatorComponent

(Appears on:ComponentSpec)

WebLogicOperatorComponent specifies the WebLogic Kubernetes Operator configuration.

Field Description

enabled
bool

(Optional)

If true, then WebLogic Kubernetes Operator will be installed.

monitorChanges
bool

(Inlined from InstallOverrides.)

(Optional)

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

overrides
[]Overrides

(Inlined from InstallOverrides.)

(Optional)

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 on git commit 238db2c3e.

Docs: Migrate from Deprecated API Versions

Mon, 01 Jan 0001 00:00:00 +0000

As the Verrazzano API evolves, APIs are periodically updated. When APIs evolve, the old API is deprecated and eventually removed. This document contains information that you need to know when migrating from deprecated API versions to newer and more stable API versions.

Verrazzano

The install.verrazzano.io/v1alpha1 API version of Verrazzano resources is deprecated and will no longer be served in a future release.

Migrate manifests and API clients to use the install.verrazzano.io/v1beta1 API version, available since 1.4.0.
All existing persisted objects are accessible using the new API.

Notable Changes In install.verrazzano.io/v1beta1

spec.components.ingress is renamed to spec.components.ingressNGINX.
spec.components.kibana is renamed to spec.components.opensearchDashboards
spec.components.elasticsearch is renamed to spec.components.opensearch
spec.components.fluentd.elasticsearchSecret is renamed to spec.components.fluentd.opensearchSecret
spec.components.fluentd.elasticsearchURL is renamed to spec.components.fluentd.opensearchURL
status.instance.kibanaUrl is renamed to status.instance.opensearchDashboardsUrl
status.instance.elasticUrl is renamed to status.instance.opensearchUrl
Use spec.components.opensearch.nodes instead of spec.components.elasticsearch.installArgs.
Use spec.components.ingressNGINX.overrides instead of spec.components.ingress.nginxInstallArgs.
Use spec.components.istio.overrides instead of spec.components.istio.istioInstallArgs.
Use spec.components.istio.overrides instead of spec.components.istio.ingress.
Use spec.components.istio.overrides instead of spec.components.istio.egress.
Use spec.components.keycloak.overrides instead of spec.components.keycloak.keycloakInstallArgs.
Use spec.components.verrazzano.overrides instead of spec.components.verrazzano.installArgs.
Use spec.components.authProxy.overrides instead of spec.components.authProxy.kubernetes.

Co-installing previous Verrazzano versions

After installing Verrazzano version 1.4.0 or later, and not uninstalling it before installing versions of Verrazzano prior to 1.4.0, will result in the following error:

The CustomResourceDefinition "verrazzanos.install.verrazzano.io" is invalid: status.storedVersions[0]: Invalid value: "v1beta1": must appear in spec.versions

To resolve this error, delete the verrazzanos.install.verrazzano.io Custom Resource Definition:

$ kubectl delete customresourcedefinition verrazzanos.install.verrazzano.io

Multicluster

Some of the multicluster wrappers APIs, which are part of clusters.verrazzano.io/v1alpha1, are deprecated and will be removed in Verrazzano v2.0.0. The APIs that will be removed are:

MultiClusterComponent - Should be replaced with a core.oam/dev/v1alpha2 Component resource.
MultiClusterConfigMap - Should be replaced with a core.oam/dev/v1alpha2 Component resource.
MultiClusterSecret - Should be replaced with a Kubernetes Secret and referenced in the spec.secrets of a MultiClusterApplicationConfiguration resource.

Verrazzano Enterprise Container Platform – API Reference

Docs: Multicluster and Verrazzano Project

clusters.verrazzano.io/v1alpha1

MultiClusterApplicationConfiguration

MultiClusterComponent

MultiClusterConfigMap

MultiClusterSecret

VerrazzanoProject

ApplicationConfigurationTemplate

Cluster

ClusterLevelStatus

ComponentTemplate

Condition

ConditionType (string alias)

ConfigMapTemplate

EmbeddedObjectMeta

MultiClusterApplicationConfigurationSpec

MultiClusterComponentSpec

MultiClusterConfigMapSpec

MultiClusterResourceStatus

MultiClusterSecretSpec

NamespaceTemplate

NetworkPolicyTemplate

NOTE

Placement

ProjectTemplate

SecretTemplate

SecuritySpec

StateType (string alias)

VerrazzanoProjectSpec

Docs: Traits and Workloads

oam.verrazzano.io/v1alpha1

IngressTrait

LoggingTrait

MetricsTrait

VerrazzanoCoherenceWorkload

VerrazzanoHelidonWorkload

VerrazzanoWebLogicWorkload

AuthorizationPolicy

AuthorizationRule

AuthorizationRuleCondition

AuthorizationRuleFrom

DeploymentTemplate

IngressDestination

NOTE

IngressDestinationHTTPCookie

IngressPath

IngressRule

IngressSecurity

IngressTraitSpec

IngressTraitStatus

LoggingTraitSpec

LoggingTraitStatus

MetricsTraitSpec

MetricsTraitStatus

PortSpec

QualifiedResourceRelation

ServiceTemplate

VerrazzanoCoherenceWorkloadSpec

VerrazzanoCoherenceWorkloadStatus

VerrazzanoHelidonWorkloadSpec

VerrazzanoHelidonWorkloadStatus

VerrazzanoWebLogicWorkloadSpec

VerrazzanoWebLogicWorkloadStatus

VerrazzanoWebLogicWorkloadTemplate

Docs: Verrazzano Managed Cluster

clusters.verrazzano.io/v1alpha1

VerrazzanoManagedCluster

ArgoCDRegistration

ArgoCDRegistrationStatus (string alias)

Condition

ConditionType (string alias)

RancherRegistration

RancherRegistrationStatus (string alias)

StateType (string alias)

VerrazzanoManagedClusterSpec

VerrazzanoManagedClusterStatus

Docs: Verrazzano v1beta1 APIs

install.verrazzano.io/v1beta1

Verrazzano

ConditionType (`string` alias)

StateType (`string` alias)

ArgoCDRegistrationStatus (`string` alias)

ConditionType (`string` alias)

RancherRegistrationStatus (`string` alias)

StateType (`string` alias)

CompStateType (`string` alias)

ComponentAvailability (`string` alias)

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

ConditionType (`string` alias)

IngressType (`string` alias)

ProfileType (`string` alias)

ProviderType (`string` alias)

VzStateType (`string` alias)