Verrazzano v1alpha1 APIs
Packages:
install.verrazzano.io/v1alpha1
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 |
|
||||||||||||||
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)Specifies the number of pod instances to run. |
affinity Kubernetes core/v1.Affinity |
(Inlined from CommonKubernetesSpec. Inlined comments are appended in the following.) (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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
Certificate
(Appears on:CertManagerComponent)
Certificate - Deprecated. Represents the type of cert issuer for an installation.
Field | Description |
---|---|
acme Acme |
(Optional)
The LetsEncrypt configuration. Either |
ca CA |
(Optional)
The LetsEncrypt configuration. Either |
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. Inlined comments are appended in the following.) (Optional)Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here; invalid values will be ignored. If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here; invalid values will be ignored. List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)IssuerConfig contains the configuration for the Verrazzano Cert-Manager ClusterIssuer The certificate configuration. |
ca CAIssuer |
(Inlined from IssuerConfig. Inlined comments are appended in the following.) (Optional)IssuerConfig contains the configuration for the Verrazzano Cert-Manager ClusterIssuer 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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 |
"Reconciling" |
CompStateReconciling is the state when a module is reconciling |
"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. |
dex DexComponent |
(Optional)
The Dex 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. |
opensearchOperator OpenSearchOperatorComponent |
(Optional)
The OpenSearchOperator 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 |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
DNSComponent
(Appears on:ComponentSpec)
DNSComponent specifies the DNS configuration.
Field | Description |
---|---|
external External |
(Optional)
External DNS configuration. |
monitorChanges bool |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. |
DexComponent
(Appears on:ComponentSpec)
DexComponent specifies the Dex configuration.
Field | Description |
---|---|
enabled bool |
(Optional)
If true, then Dex will be installed. |
monitorChanges bool |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
FluentbitOpensearchOutputComponent
(Appears on:ComponentSpec)
Field | Description |
---|---|
enabled bool |
(Optional)
If true, then the FluentbitOpensearchOutput will be installed. |
monitorChanges bool |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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
|
elasticsearchURL string |
(Optional)
The target OpenSearch URLs.
Specify this option in this format.
The default |
enabled bool |
(Optional)
If true, then Fluentd will be installed. |
extraVolumeMounts []VolumeMount |
(Optional)
A list of host path volume mounts, in addition to |
monitorChanges bool |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 |
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 |
monitorChanges bool |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 |
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 |
overrides []Overrides |
(Optional)
List of overrides for the default |
InstanceInfo
(Appears on:VerrazzanoStatus)
InstanceInfo details of installed Verrazzano instance maintained in status field.
Field | Description |
---|---|
alertmanagerUrl string |
The Alertmanager URL for this Verrazzano installation. |
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. |
thanosRulerUrl string |
The Thanos Ruler URL for this Verrazzano installation. |
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 |
monitorChanges bool |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for default IstioOperator. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here Passing through an invalid IstioOperator resource will result in an error. If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for default IstioOperator. Overrides are merged together, but in the event of conflicting fields, the last override in the list takes precedence over any others. You can find all possible values here Passing through an invalid IstioOperator resource will result in an error. List of overrides for the default |
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 |
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. Inlined comments are appended in the following.) (Optional)Specifies the number of pod instances to run. |
affinity Kubernetes core/v1.Affinity |
(Inlined from CommonKubernetesSpec. Inlined comments are appended in the following.) (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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
OCI
(Appears on:DNSComponent)
OCI DNS type.
Field | Description |
---|---|
dnsScope string |
(Optional)
Scope of the Oracle Cloud Infrastructure DNS zone ( |
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
|
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 |
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. |
OpenSearchOperatorComponent
(Appears on:ComponentSpec)
OpenSearchOperatorComponent specifies the OpenSearchOperator configuration.
Field | Description |
---|---|
enabled bool |
(Optional)
If true, then OpenSearchOperator will be installed. |
monitorChanges bool |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of Overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of Overrides for the default List of overrides for the default |
Overrides
(Appears on:ApplicationOperatorComponent, ArgoCDComponent, AuthProxyComponent, CertManagerComponent, CertManagerWebhookOCIComponent, ClusterAPIComponent, ClusterAgentComponent, ClusterOperatorComponent, CoherenceOperatorComponent, ConsoleComponent, DNSComponent, DexComponent, FluentOperatorComponent, FluentbitOpensearchOutputComponent, FluentdComponent, IngressNginxComponent, InstallOverrides, IstioComponent, JaegerOperatorComponent, KeycloakComponent, KialiComponent, KubeStateMetricsComponent, MySQLComponent, MySQLOperatorComponent, OAMComponent, OpenSearchOperatorComponent, 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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
keycloakAuthEnabled bool |
(Optional)
KeycloakAuthEnabled specifies whether the Keycloak Auth provider is enabled. Default is |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 |
environmentName string |
(Optional)
Name of the installation. This name is part of the endpoint access URLs that are generated.
The default value is |
profile ProfileType |
(Optional)
The installation profile to select. Valid values are |
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 themetadata field.
|
||||||||||||||||
spec Kubernetes core/v1.PersistentVolumeClaimSpec |
A
|
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 |
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. Inlined comments are appended in the following.) (Optional)List of overrides for the default If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to |
overrides []Overrides |
(Inlined from InstallOverrides. Inlined comments are appended in the following.) (Optional)List of overrides for the default List of overrides for the default |
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 2f95b4017
.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.