Verrazzano Enterprise Container Platform – API

Docs: IngressTrait Custom Resource Definition

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

The IngressTrait custom resource contains the configuration of host and path rules for traffic routing to an application. Here is a sample ApplicationConfiguration that specifies an IngressTrait. To deploy an example application that demonstrates this IngressTrait, see Hello World Helidon.

apiVersion: core.oam.dev/v1alpha2
kind: ApplicationConfiguration
metadata:
  name: hello-helidon-appconf
  namespace: hello-helidon
  annotations:
    version: v1.0.0
    description: "Hello Helidon application"
spec:
  components:
    - componentName: hello-helidon-component
      traits:
        - trait:
            apiVersion: oam.verrazzano.io/v1alpha1
            kind: MetricsTrait
            spec:
                scraper: verrazzano-system/vmi-system-prometheus-0
        - trait:
            apiVersion: oam.verrazzano.io/v1alpha1
            kind: IngressTrait
            metadata:
              name: hello-helidon-ingress
            spec:
              rules:
                - paths:
                    - path: "/greet"
                      pathType: Prefix

In the sample configuration, the IngressTrait hello-helidon-ingress is set on the hello-helidon-component application component and defines an ingress rule that configures a path and path type. This exposes a route for external access to the application. Note that because no hosts list is given for the IngressRule, a DNS host name is automatically generated.

For example, with the sample application configuration successfully deployed, the application will be accessible with the path specified in the IngressTrait and the generated host name.

$ HOST=$(kubectl get gateways.networking.istio.io hello-helidon-hello-helidon-appconf-gw -n hello-helidon -o jsonpath={.spec.servers[0].hosts[0]})
$ echo $HOST
hello-helidon-appconf.hello-helidon.11.22.33.44.nip.io

$ curl -sk -X GET https://${HOST}/greet

Alternatively, specific host names can be given in an IngressRule. Doing this implies that a secret and certificate have been created for the specific hosts and the secret name has been specified in the associated IngressSecurity secretName field.

Load balancer session affinity is configured using an HTTP cookie in a destination rule. Here is an updated sample ApplicationConfiguration that includes a destination rule with an HTTP cookie.

apiVersion: core.oam.dev/v1alpha2
kind: ApplicationConfiguration
metadata:
  name: hello-helidon-appconf
  namespace: hello-helidon
  annotations:
    version: v1.0.0
    description: "Hello Helidon application"
spec:
  components:
    - componentName: hello-helidon-component
      traits:
        - trait:
            apiVersion: oam.verrazzano.io/v1alpha1
            kind: MetricsTrait
            spec:
                scraper: verrazzano-system/vmi-system-prometheus-0
        - trait:
            apiVersion: oam.verrazzano.io/v1alpha1
            kind: IngressTrait
            metadata:
              name: hello-helidon-ingress
            spec:
              rules:
                - paths:
                    - path: "/greet"
                      pathType: Prefix
                - destination:
                    httpCookie:
                      name: sessioncookie
                      path: "/"
                      ttl: 600

IngressTrait

Field	Type	Description	Required
`apiVersion`	string	`oam.verrazzano.io/v1alpha1`	Yes
`kind`	string	IngressTrait	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	IngressTraitSpec	The desired state of an ingress trait.	Yes

IngressTraitSpec

IngressTraitSpec specifies the desired state of an ingress trait.

Field	Type	Description	Required
`rules`	IngressRule array	A list of ingress rules to for an ingress trait.	Yes
`tls`	IngressSecurity	The security parameters for an ingress trait. This is required only if specific hosts are given in an IngressRule.	No

IngressRule

IngressRule specifies a rule for an ingress trait.

Field	Type	Description	Required
`hosts`	string array	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.	No
`paths`	IngressPath array	The paths to be exposed for an ingress trait.	Yes
`destination`	IngressDestination	The destination host and port for the ingress paths.	No

IngressPath

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

Field	Type	Description	Required
`path`	string	If no path is provided, it defaults to `/`.	No
`pathType`	string	Path type values are case-sensitive and formatted as follows: `exact`: exact string match `prefix`: prefix-based match `regex`: regex-based match If the provided ingress path doesn’t contain a `pathType`, it defaults to `prefix` if the path is `/` and `exact` otherwise.	No

IngressDestination

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

Field	Type	Description	Required
`host`	string	Destination host.	No
`port`	uint32	Destination port.	No
`httpCookie`	HttpCookie	Session affinity cookie.	No

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

HttpCookie

HttpCookie specifies a session affinity cookie for an ingress trait.

Field	Type	Description	Required
`name`	string	The name of the HTTP cookie.	No
`path`	string	The path of the HTTP cookie.	No
`ttl`	uint32	The lifetime of the HTTP cookie (in seconds).	No

IngressSecurity

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

Field	Type	Description	Required
`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.	Yes

Docs: LoggingTrait Custom Resource Definition

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

The LoggingTrait custom resource contains the configuration for an additional logging sidecar with a custom image and Fluentd configuration file. Here is a sample ApplicationConfiguration that includes a LoggingTrait. To deploy an example application with this LoggingTrait, replace the ApplicationConfiguration of the ToDo-List example application with the following sample.

apiVersion: core.oam.dev/v1alpha2
kind: ApplicationConfiguration
metadata:
  name: todo-appconf
  namespace: todo-list
  annotations:
    version: v1.0.0
    description: "ToDo List example application"
spec:
  components:
    - componentName: todo-domain
      traits:
        - trait:
            apiVersion: oam.verrazzano.io/v1alpha1
            kind: LoggingTrait
            metadata:
              name: logging-trait-example
              namespace: todo-list
            spec:
              loggingImage: fluent/fleuntd-example-image # Replace with custom Fluentd Image
              loggingConfig: |-
                # Replace with Fluentd config file
                <match **>
                @type stdout
                </match>                
    - componentName: todo-jdbc-configmap
    - componentName: todo-mysql-configmap
    - componentName: todo-mysql-service
    - componentName: todo-mysql-deployment

In this sample configuration, the LoggingTrait logging-trait-example is set on the todo-domain application component and defines a logging sidecar with the given Fluentd image and configuration file. This sidecar will be attached to the component’s pod and will gather logs according to the given Fluentd configuration file. In order for the Fluentd DaemonSet to collect the custom logs, the Fluentd configuration file needs to direct the logs to STDOUT, as demonstrated in the previous example.

For example, when the ToDo-List example ApplicationConfiguration is successfully deployed with a LoggingTrait, the tododomain-adminserver pod will have a container named logging-stdout.

$ kubectl get pods tododomain-adminserver -n todo-list -o jsonpath='{.spec.containers[*].name}'
  ... logging-stdout ...

In this example, the logging-stdout container will run the image given in the LoggingTrait and a ConfigMap named logging-stdout-todo-domain-domain will be created with the custom Fluentd configuration file.

LoggingTrait

Field	Type	Description	Required
`apiVersion`	string	`oam.verrazzano.io/v1alpha1`	Yes
`kind`	string	LoggingTrait	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	LoggingTraitSpec	The desired state of a logging trait.	Yes

LoggingTraitSpec

LoggingTraitSpec specifies the desired state of a logging trait.

Field	Type	Description	Required
`loggingConfig`	string	A string representation of the Fluentd configuration.	Yes
`loggingImage`	string	The name of the custom Fluentd image.	Yes

Docs: Metrics Template Custom Resource Definition

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

The Metrics Template CRD contains the metrics configuration for default Kubernetes workloads. Here is the default Metrics Template that Verrazzano installs.

apiVersion: app.verrazzano.io/v1alpha1
kind: MetricsTemplate
metadata:
  name: standard-k8s-metrics-template
  namespace: verrazzano-system
spec:
  workloadSelector:
    apiGroups: ["apps", ""]
    apiVersions: ["v1"]
    resources: ["deployment", "statefulset", "replicaset", "pod"]
  prometheusConfig:
    targetConfigMap:
      namespace: verrazzano-system
      name: vmi-system-prometheus-config
    scrapeConfigTemplate: |
      kubernetes_sd_configs:
        - namespaces:
            names:
            - {{`{{.workload.metadata.namespace}}`}}
          role: pod
      relabel_configs:
        - action: replace
          replacement: local
          source_labels: null
          target_label: verrazzano_cluster
        - action: keep
          regex: {{`{{index .workload.metadata.labels "app.verrazzano.io/workload"}}`}};true
          source_labels:
            - __meta_kubernetes_pod_label_app_verrazzano_io_workload
            - __meta_kubernetes_pod_annotation_prometheus_io_scrape
        - action: replace
          regex: ([^:]+)(?::\d+)?;(\d+)
          replacement: $1:$2
          source_labels:
            - __address__
            - __meta_kubernetes_pod_annotation_prometheus_io_port
          target_label: __address__
        - action: replace
          regex: (.*)
          source_labels:
            - __meta_kubernetes_pod_annotation_prometheus_io_path
          target_label: __metrics_path__
        - action: replace
          regex: (.*)
          replacement: $1
          source_labels:
            - __meta_kubernetes_namespace
          target_label: namespace
        - action: labelmap
          regex: __meta_kubernetes_pod_label_(.+)
        - action: replace
          source_labels:
            - __meta_kubernetes_pod_name
          target_label: pod_name
        - action: labeldrop
          regex: (controller_revision_hash)
        - action: replace
          regex: .*/(.*)$
          replacement: $1
          source_labels:
            - name
          target_label: webapp
      {{`{{ if index .namespace.metadata.labels "istio-injection" }}`}}
      {{`{{ if eq (index .namespace.metadata.labels "istio-injection" ) "enabled" }}`}}
      scheme: https
      tls_config:
        ca_file: /etc/istio-certs/root-cert.pem
        cert_file: /etc/istio-certs/cert-chain.pem
        insecure_skip_verify: true
        key_file: /etc/istio-certs/key.pem
      {{`{{ end }}`}}
      {{`{{ end }}`}}

For more information on using the Metrics Template, see Metrics Template.

MetricsTemplate

Field	Type	Description	Required
`apiVersion`	string	`app.verrazzano.io/v1alpha1`	Yes
`kind`	string	MetricsTemplate	Yes
`metadata`	ObjectMeta	Refer to the Kubernetes API documentation for fields of metadata.	No
`spec`	MetricsTemplateSpec	The desired state of a metrics trait.	Yes

MetricsTemplateSpec

Field	Type	Description	Required
`workloadSelector`	WorkloadSelector	Selector for target workloads.	No
`prometheusConfig`	PrometheusConfig	Prometheus configuration details.	No

WorkloadSelector

Field	Type	Description	Required
`namespaceSelector`	LabelSelector	Scopes the template to a namespace.	No
`objectSelector`	LabelSelector	Scopes the template to a specific workload object.	No
`apiGroups`	[]string	Scopes the template to given API Groups.	No
`apiVersions`	[]string	Scopes the template to given API Versions.	No
`resources`	[]string	Scopes the template to given API Resources.	No

PrometheusConfig

Field	Type	Description	Required
`targetConfigMap`	TargetConfigMap	Identity of the ConfigMap to be updated with the scrape configuration specified in `scrapeConfigTemplate`.	Yes
`scrapeConfigTemplate`	string	Scrape configuration template to be added to the Prometheus configuration.	Yes

TargetConfigMap

Field	Type	Description	Required
`namespace`	string	Namespace of the ConfigMap to be updated with the scrape target configuration.	Yes
`name`	string	Name of the ConfigMap to be updated with the scrape target configuration.	Yes

Docs: MetricsTrait Custom Resource Definition

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

The MetricsTrait custom resource contains the configuration information needed to enable metrics for an application component. Component workloads configured with a MetricsTrait are set up to emit metrics through an endpoint that are scraped by a given Prometheus deployment. Here is a sample ApplicationConfiguration that specifies a MetricsTrait. To deploy an example application that demonstrates a MetricsTrait, see Hello World Helidon.

Note that if an ApplicationConfiguration does not specify a MetricsTrait, then a default MetricsTrait will be generated with values appropriate for the workload type.

apiVersion: core.oam.dev/v1alpha2
kind: ApplicationConfiguration
metadata:
  name: hello-helidon-appconf
  namespace: hello-helidon
  annotations:
    version: v1.0.0
    description: "Hello Helidon application"
spec:
  components:
    - componentName: hello-helidon-component
      traits:
        - trait:
            apiVersion: oam.verrazzano.io/v1alpha1
            kind: MetricsTrait
            spec:
                scraper: verrazzano-system/vmi-system-prometheus-0
        - trait:
            apiVersion: oam.verrazzano.io/v1alpha1
            kind: IngressTrait
            metadata:
              name: hello-helidon-ingress
            spec:
              rules:
                - paths:
                    - path: "/greet"
                      pathType: Prefix

In the sample configuration, a MetricsTrait is specified for the hello-helidon-component application component.

With the sample application configuration successfully deployed, you can query for metrics from the application component.

$ HOST=$(kubectl get ingress \
     -n verrazzano-system vmi-system-prometheus \
     -o jsonpath={.spec.rules[0].host})
$ echo $HOST

prometheus.vmi.system.default.<ip>.nip.io

$ VZPASS=$(kubectl get secret \
     --namespace verrazzano-system verrazzano \
     -o jsonpath={.data.password} | base64 \
     --decode; echo)
$ curl -sk \
    --user verrazzano:${VZPASS} \
    -X GET https://${HOST}/api/v1/query?query=vendor_requests_count_total

{"status":"success","data":{"resultType":"vector","result":[{"metric":{"__name__":"vendor_requests_count_total","app":"hello-helidon","app_oam_dev_component":"hello-helidon-component","app_oam_dev_name":"hello-helidon-appconf","app_oam_dev_resourceType":"WORKLOAD","app_oam_dev_revision":"hello-helidon-component-v1","containerizedworkload_oam_crossplane_io":"496df78f-ef8b-4753-97fd-d9218d2f38f1","job":"hello-helidon-appconf_default_helidon-logging_hello-helidon-component","namespace":"helidon-logging","pod_name":"hello-helidon-workload-b7d9d95d8-ht7gb","pod_template_hash":"b7d9d95d8"},"value":[1616535232.487,"4800"]}]}}

MetricsTrait

Field	Type	Description	Required
`apiVersion`	string	`oam.verrazzano.io/v1alpha1`	Yes
`kind`	string	MetricsTrait	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	MetricsTraitSpec	The desired state of a metrics trait.	Yes

MetricsTraitSpec

MetricsTraitSpec specifies the desired state of a metrics trait.

Field	Type	Description	Required
`port`	integer	The HTTP port for the related metrics endpoint. Defaults to `8080`.	No
`ports`	[]PortSpec	The HTTP endpoints for the related metrics.	No
`path`	string	The HTTP path for the related metrics endpoint. Defaults to `/metrics`.	No
`secret`	string	The name of an opaque secret (for example, user name and password) within the workload’s namespace for metrics endpoint access.	No
`scraper`	string	The Prometheus deployment used to scrape the related metrics endpoints. Defaults to `verrazzano-system/vmi-system-prometheus-0`.	No

PortSpec

PortSpec defines an HTTP port and path combination.

Field	Type	Description	Required
`port`	integer	The HTTP port for the related metrics endpoint. Defaults to `8080`.	No
`path`	string	The HTTP path for the related metrics endpoint. Defaults to `/metrics`.	No

Docs: MultiClusterApplicationConfiguration Custom Resource Definition

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

The MultiClusterApplicationConfiguration custom resource is an envelope used to distribute core.oam.dev/v1alpha2/ApplicationConfiguration resources in a multicluster environment.

Here is a sample MultiClusterApplicationConfiguration that specifies an ApplicationConfiguration resource to create on the cluster named managed1. To deploy an example application that demonstrates a MultiClusterApplicationConfiguration, see Multicluster ToDo List.

apiVersion: clusters.verrazzano.io/v1alpha1
kind: MultiClusterApplicationConfiguration
metadata:
  name: todo-appconf
  namespace: mc-todo-list
spec:
  template:
    metadata:
      annotations:
        version: v1.0.0
        description: "ToDo List example application"
    spec:
      components:
        - componentName: todo-domain
          traits:
            - trait:
                apiVersion: oam.verrazzano.io/v1alpha1
                kind: MetricsTrait
                spec:
                  scraper: verrazzano-system/vmi-system-prometheus-0
            - trait:
                apiVersion: oam.verrazzano.io/v1alpha1
                kind: IngressTrait
                spec:
                  rules:
                    - paths:
                        - path: "/todo"
                          pathType: Prefix
        - componentName: todo-jdbc-config
        - componentName: mysql-initdb-config
        - componentName: todo-mysql-service
        - componentName: todo-mysql-deployment
  placement:
    clusters:
      - name: managed1
  secrets:
    - tododomain-repo-credentials
    - tododomain-jdbc-tododb
    - tododomain-weblogic-credentials

MultiClusterApplicationConfiguration

A MultiClusterApplicationConfiguration is an envelope to create core.oam.dev/v1alpha2/ApplicationConfiguration resources on the clusters specified in the placement section.

Field	Type	Description	Required
`apiVersion`	string	`clusters.verrazzano.io/v1alpha1`	Yes
`kind`	string	MultiClusterApplicationConfiguration	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	MultiClusterApplicationConfigurationSpec	The desired state of a `core.oam.dev/v1alpha2/ApplicationConfiguration` resource.	Yes
`status`	MultiClusterResourceStatus	The runtime status of a multicluster resource.	No

MultiClusterApplicationConfigurationSpec

MultiClusterApplicationConfigurationSpec specifies the desired state of a core.oam.dev/v1alpha2/ApplicationConfiguration resource.

Field	Type	Description	Required
`template`	ApplicationConfigurationTemplate	The embedded `core.oam.dev/v1alpha2/ApplicationConfiguration` resource.	Yes
`placement`	Placement	Clusters in which the resource is to be placed.	Yes
`secrets`	string array	List of secrets used by the application. These secrets must be created in the application’s namespace before deploying a MultiClusterApplicationConfiguration resource.	No

ApplicationConfigurationTemplate

ApplicationConfigurationTemplate has the metadata and spec of the core.oam.dev/v1alpha2/ApplicationConfiguration resource.

Field	Type	Description	Required
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	ApplicationConfigurationSpec	An instance of the `struct` ApplicationConfigurationSpec defined in core_types.go.	No

Docs: MultiClusterComponent Custom Resource Definition

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

The MultiClusterComponent custom resource is an envelope used to distribute core.oam.dev/v1alpha2/Component resources in a multicluster environment.

NOTE

Starting with Verrazzano v1.1.0, it is preferred that the MultiClusterComponent custom resource not be used; instead directly use core.oam.dev/v1alpha2/Component resources in your application. See the example application, Multicluster ToDo List, which directly uses core.oam.dev/v1alpha2/Component resources.

Here is a sample MultiClusterComponent that specifies a OAM Component resource to create on the cluster named managed1.

apiVersion: clusters.verrazzano.io/v1alpha1
kind: MultiClusterComponent
metadata:
  name: hello-helidon-component
  namespace: hello-helidon
spec:
  template:
    spec:
      workload:
        apiVersion: oam.verrazzano.io/v1alpha1
        kind: VerrazzanoHelidonWorkload
        metadata:
          name: hello-helidon-workload
          namespace: hello-helidon
          labels:
            app: hello-helidon
        spec:
          deploymentTemplate:
            metadata:
              name: hello-helidon-deployment
            podSpec:
              containers:
                - name: hello-helidon-container
                  image: "ghcr.io/verrazzano/example-helidon-greet-app-v1:0.1.12-1-20210409130027-707ecc4"
                  ports:
                    - containerPort: 8080
                      name: http
  placement:
    clusters:
      - name: managed1

MultiClusterComponent

A MultiClusterComponent is an envelope to create core.oam.dev/v1alpha2/Component resources on the clusters specified in the placement section.

Field	Type	Description	Required
`apiVersion`	string	`clusters.verrazzano.io/v1alpha1`	Yes
`kind`	string	MultiClusterComponent	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	MultiClusterComponentSpec	The desired state of a `core.oam.dev/v1alpha2/Component` resource.	Yes
`status`	MultiClusterResourceStatus	The runtime status of a multicluster resource.	No

MultiClusterComponentSpec

MultiClusterComponentSpec specifies the desired state of a core.oam.dev/v1alpha2/Component resource.

Field	Type	Description	Required
`template`	ComponentTemplate	The embedded `core.oam.dev/v1alpha2/Component` resource.	Yes
`placement`	Placement	Clusters in which the resource is to be placed.	Yes

ComponentTemplate

ComponentTemplate has the metadata and spec of the core.oam.dev/v1alpha2/Component resource.

Field	Type	Description	Required
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	ComponentSpec	An instance of the `struct` ComponentSpec defined in core_types.go.	No

Docs: MultiClusterConfigMap Custom Resource Definition

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

The MultiClusterConfigMap custom resource is an envelope used to distribute Kubernetes ConfigMap resources in a multicluster environment.

NOTE

Starting with Verrazzano v1.1.0, it is preferred that the MultiClusterConfigMap custom resource not be used; instead directly use core.oam.dev/v1alpha2/Component to define ConfigMap resources in your application. See the example application, Multicluster ToDo List, which uses core.oam.dev/v1alpha2/Component resources to define ConfigMaps.

Here is a sample MultiClusterConfigMap that specifies a Kubernetes ConfigMap to create on the cluster named managed1.

apiVersion: clusters.verrazzano.io/v1alpha1
kind: MultiClusterConfigMap
metadata:
  name: mymcconfigmap
  namespace: multiclustertest
spec:
  template:
    metadata:
      name: myconfigmap
      namespace: myns
    data:
      simple.key: "simplevalue"
  placement:
    clusters:
      - name: managed1

MultiClusterConfigMap

A MultiClusterConfigMap is an envelope to create Kubernetes ConfigMap resources on the clusters specified in the placement section.

Field	Type	Description	Required
`apiVersion`	string	`clusters.verrazzano.io/v1alpha1`	Yes
`kind`	string	MultiClusterConfigMap	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	MultiClusterConfigMapSpec	The desired state of a Kubernetes ConfigMap.	Yes
`status`	MultiClusterResourceStatus	The runtime status of a multicluster resource.	No

MultiClusterConfigMapSpec

MultiClusterConfigMapSpec specifies the desired state of a Kubernetes ConfigMap.

Field	Type	Description	Required
`template`	ConfigMapTemplate	The embedded Kubernetes ConfigMap.	Yes
`placement`	Placement	Clusters in which the ConfigMap is to be placed.	Yes

ConfigMapTemplate

ConfigMapTemplate has the metadata and spec of the Kubernetes ConfigMap.

Field	Type	Description	Required
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`immutable`	*bool	Corresponds to the `immutable` field of the `struct` ConfigMap defined in types.go.	No
`data`	map[string]string	Corresponds to the `data` field of the `struct` ConfigMap defined in types.go.	No
`binaryData`	map[string][]byte	Corresponds to the `binaryData` field of the `struct` ConfigMap defined in types.go.	No

Docs: MultiClusterResourceStatus Subresource

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

The MultiClusterResourceStatus subresource is shared by multicluster custom resources.

MultiClusterResourceStatus

MultiClusterResourceStatus specifies the status portion of a multicluster resource.

Field	Type	Description	Required
`conditions`	Condition array	The current state of a multicluster resource.	No
`state`	string	The state of the multicluster resource. State values are case-sensitive and formatted as follows: `Pending`: deployment to cluster is in progress `Succeeded`: deployment to cluster successfully completed `Failed`: deployment to cluster failed	No
`clusters`	ClusterLevelStatus array	Array of status information for each cluster.	No

Condition

Condition describes current state of a multicluster resource across all clusters.

Field	Type	Description	Required
`type`	string	The condition of the multicluster resource which can be checked with a `kubectl wait` command. Condition values are case-sensitive and formatted as follows: `DeployComplete`: deployment to all clusters completed successfully `DeployFailed`: deployment to all clusters failed	Yes
`status`	ConditionStatus	An instance of the type ConditionStatus that is defined in types.go.	Yes
`lastTransitionTime`	string	The last time the condition transitioned from one status to another.	No
`message`	string	A message with details about the last transition.	No

ClusterLevelStatus

ClusterLevelStatus describes the status of the multicluster resource on an individual cluster.

Field	Type	Description	Required
`name`	string	Name of the cluster.	Yes
`state`	string	The state of the multicluster resource. State values are case-sensitive and formatted as follows: `Pending`: deployment is in progress `Succeeded`: deployment successfully completed `Failed`: deployment failed	No
`message`	string	Message with details about the status in this cluster.	No
`lastUpdateTime`	string	The last time the resource state was updated.	Yes

Docs: MultiClusterSecret Custom Resource Definition

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

The MultiClusterSecret custom resource is an envelope used to distribute Kubernetes Secret resources in a multicluster environment.

NOTE

Starting with Verrazzano v1.1.0, it is preferred that the MultiClusterSecret custom resource not be used; instead specify secrets in the MultiClusterApplicationConfiguration resource. See the example application, Multicluster ToDo List where secrets are specified in a MultiClusterApplicationConfiguration resource.

Here is a sample MultiClusterSecret that specifies a Kubernetes secret to create on the cluster named managed1.

apiVersion: clusters.verrazzano.io/v1alpha1
kind: MultiClusterSecret
metadata:
  name: mymcsecret
  namespace: multiclustertest
spec:
  template:
    data:
      username: dmVycmF6emFubw==
      password: dmVycmF6emFubw==
  spec:
  placement:
    clusters:
      - name: managed1

MultiClusterSecret

A MultiClusterSecret is an envelope to create Kubernetes Secret resources on the clusters specified in the placement section.

Field	Type	Description	Required
`apiVersion`	string	`clusters.verrazzano.io/v1alpha1`	Yes
`kind`	string	MultiClusterSecret	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	MultiClusterSecretSpec	The desired state of a Kubernetes Secret.	Yes
`status`	MultiClusterResourceStatus	The runtime status of a multicluster resource.	No

MultiClusterSecretSpec

MultiClusterSecretSpec specifies the desired state of a Kubernetes Secret.

Field	Type	Description	Required
`template`	SecretTemplate	The embedded Kubernetes Secret.	Yes
`placement`	Placement	Clusters in which the Secret is to be placed.	Yes

SecretTemplate

SecretTemplate has the metadata and spec of the Kubernetes Secret.

Field	Type	Description	Required
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`data`	map[string][]byte	Corresponds to the `data` field of the `struct` Secret defined in types.go.	No
`stringData`	map[string]string	Corresponds to the `stringData` field of the `struct` Secret defined in types.go.	No
`type`	string	Corresponds to the `type` field of the `struct` Secret defined in types.go.	No

Docs: Placement Subresource

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

The Placement subresource is shared by multicluster custom resources.

Placement

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

Field	Type	Description	Required
`clusters`	Cluster array	An array of cluster locations.	Yes

Cluster

Cluster contains the name of a single cluster.

Field	Type	Description	Required
`cluster`	string	The name of a cluster.	Yes

Docs: Verrazzano Custom Resource Definition

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

The Verrazzano custom resource contains the configuration information for an installation. Here is a sample Verrazzano custom resource file that uses Oracle Cloud Infrastructure DNS. See other examples here.

apiVersion: install.verrazzano.io/v1alpha1
kind: Verrazzano
metadata:
  name: example-verrazzano
spec:
  environmentName: env
  profile: prod
  components:
    certManager:
      certificate:
        acme:
          provider: letsEncrypt
          emailAddress: emailAddress@example.com
    dns:
      oci:
        ociConfigSecret: oci
        dnsZoneCompartmentOCID: dnsZoneCompartmentOcid
        dnsZoneOCID: dnsZoneOcid
        dnsZoneName: my.dns.zone.name
    ingress:
      type: LoadBalancer

VerrazzanoSpec

Field	Type	Description	Required
`environmentName`	string	Name of the installation. This name is part of the endpoint access URLs that are generated. The default value is `default`.	No
`profile`	string	The installation profile to select. Valid values are `prod` (production), `dev` (development), and `managed-cluster`. The default is `prod`.	No
`version`	string	The version to install. Valid versions can be found here. Defaults to the current version supported by the Verrazzano platform operator.	No
`components`	Components	The Verrazzano components.	No
`defaultVolumeSource`	VolumeSource	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.	No
`volumeClaimSpecTemplates`	VolumeClaimSpecTemplate	Defines a named set of PVC configurations that can be referenced from components to configure persistent volumes.	No

VolumeClaimSpecTemplate

Field	Type	Description	Required
`metadata`	ObjectMeta	Metadata about the PersistentVolumeClaimSpec template.	No
`spec`	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.	No

Components

Field	Type	Description	Required
`authProxy`	AuthProxyComponent	The AuthProxy component configuration.	No
`certManager`	CertManagerComponent	The cert-manager component configuration.	No
`dns`	DNSComponent	The DNS component configuration.	No
`ingress`	IngressComponent	The ingress component configuration.	No
`istio`	IstioComponent	The Istio component configuration.	No
`fluentd`	FluentdComponent	The Fluentd component configuration.	No
`jaegerOperator`	JaegerOperatorComponent	The Jaeger Operator component configuration.	No
`keycloak`	KeycloakComponent	The Keycloak component configuration.	No
`elasticsearch`	OpenSearchComponent	The OpenSearch component configuration.	No
`prometheus`	PrometheusComponent	The Prometheus component configuration.	No
`kibana`	OpenSearchDashboardsComponent	The OpenSearch Dashboards component configuration.	No
`grafana`	GrafanaComponent	The Grafana component configuration.	No
`kiali`	KialiComponent	The Kiali component configuration.	No
`prometheusOperator`	PrometheusOperatorComponent	The Prometheus Operator component configuration.	No
`prometheusAdapter`	PrometheusAdapterComponent	The Prometheus Adapter component configuration.	No
`kubeStateMetrics`	KubeStateMetricsComponent	The kube-state-metrics component configuration.	No

AuthProxy Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then AuthProxy will be installed.	No
`kubernetes`	AuthProxyKubernetes	The Kubernetes resources than can be configured for AuthProxy.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

AuthProxy Kubernetes Configuration

Field	Type	Description	Required
`replicas`	uint32	The number of pods to replicate.	No
`affinity`	Affinity	A Kubernetes affinity definition.	No

CertManager Component

Field	Type	Description	Required
`certificate`	Certificate	The certificate configuration.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

Certificate

Field	Type	Description	Required
`acme`	Acme	The ACME configuration. Either `acme` or `ca` must be specified.	No
`ca`	CertificateAuthority	The certificate authority configuration. Either `acme` or `ca` must be specified.	No

Acme

Field	Type	Description	Required
`provider`	string	Name of the Acme provider.	Yes
`emailAddress`	string	Email address of the user.	Yes

CertificateAuthority

Field	Type	Description	Required
`secretName`	string	The secret name.	Yes
`clusterResourceNamespace`	string	The secrete namespace.	Yes

DNS Component

Field	Type	Description	Required
`wildcard`	DNS-Wilcard	Wildcard DNS configuration. This is the default with a domain of `nip.io`.	No
`oci`	DNS-OCI	Oracle Cloud Infrastructure DNS configuration.	No
`external`	DNS-External	External DNS configuration.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

DNS Wildcard

Field	Type	Description	Required
`domain`	string	The type of wildcard DNS domain. For example, `nip.io`, `sslip.io`, and such.	Yes

DNS Oracle Cloud Infrastructure

Field	Type	Description	Required
`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`.	Yes
`dnsZoneCompartmentOCID`	string	The Oracle Cloud Infrastructure DNS compartment OCID.	Yes
`dnsZoneOCID`	string	The Oracle Cloud Infrastructure DNS zone OCID.	Yes
`dnsZoneName`	string	Name of Oracle Cloud Infrastructure DNS zone.	Yes
`dnsScope`	string	Scope of the Oracle Cloud Infrastructure DNS zone (`PRIVATE`, `GLOBAL`). If not specified, then defaults to `GLOBAL`.	No

DNS External

Field	Type	Description	Required
`suffix`	string	The suffix for DNS names.	Yes

Ingress Component

Field	Type	Description	Required
`type`	string	The ingress type. Valid values are `LoadBalancer` and `NodePort`. The default value is `LoadBalancer`. If the ingress type is `NodePort`, a valid and accessible IP address must be specified using the `controller.service.externalIPs` key in NGINXInstallArgs. For sample usage, see External Load Balancers.	No
`nginxInstallArgs`	NGINXInstallArgs list	A list of values to use during NGINX installation.	No
`ports`	PortConfig list	The list port configurations used by the ingress.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

NGINX Install Args

Name	Type	ValueType	Description	Required
`controller.service.externalIPs`	NameValue	string list	The external IP address used by the NGINX Ingress Controller.	No
`controller.service.externalTrafficPolicy`	NameValue	string	Preserves the client source IP address. See Bare-metal considerations.	No
`controller.service.annotations.*`	NameValue	string	Annotations used for NGINX Ingress Controller. For sample usage, see Customize Ingress.	No
`controller.autoscaling.enabled`	NameValue	Boolean	If true, then enable horizonal pod autoscaler. Default `false`.	No
`controller.autoscaling.minReplicas`	NameValue	string	Minimum replicas used for autoscaling. Default `1`.	No

Port Config

Field	Type	Description	Required
`name`	string	The port name.	No
`port`	string	The port value.	Yes
`targetPort`	string	The target port value. The default is same as the port value.	Yes
`protocol`	string	The protocol used by the port. `TCP` is the default.	No
`nodePort`	string	The `nodePort` value.	No

Name Value

Field	Type	Description	Required
`name`	string	The name of a Helm override for a Verrazzano component chart, specified with a `—set` flag on the Helm command line, for example, `helm install --set name=value`. For more information about chart overrides, see Customize Ingress.	Yes
`value`	string	The value of a Helm override for a Verrazzano component chart, specified with a `—set` flag on the Helm command line, for example, `helm install --set name=value`. Either `value` or `valueList` must be specified. For more information about chart overrides, see Customize Ingress.	No
`valueList`	string list	The list of Helm override values for a Verrazzano component, each specified with a `—set` flag on the Helm command line, for example, `helm install --set name[0]=<first element of valueList> —set name[1]=<second element of valueList>`. Either `value` or `valueList` must be specified. For more information about chart overrides, see Customize Ingress.	No
`setString`	Boolean	Specifies if the argument requires the Helm `--set-string` command-line flag to override a chart value, for example, `helm install --set-string name=value`.	No

Istio Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then Istio will be installed.	No
`istioIngress`	IstioIngress	The Istio ingress gateway configuration.	No
`istioEgress`	IstioEgress	The Istio egress gateway configuration.	No
`istioInstallArgs`	IstioInstallArgs list	A list of values to use during Istio installation. Each argument is specified as either a `name/value` or `name/valueList` pair.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for default IstioOperator. Lower Overrides have precedence over the ones above them. You can find all possible values here. Passing through an invalid IstioOperator resource will result in an error.	No

Istio Ingress Configuration

Field	Type	Description	Required
`type`	string	The Istio ingress type. Valid values are `LoadBalancer` and `NodePort`. The default value is `LoadBalancer`. If the Istio ingress type is `NodePort`, 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.	No
`ports`	PortConfig list	The list port configurations used by the Istio ingress.	No
`kubernetes`	IstioKubernetes	The Kubernetes resources than can be configured for an Istio ingress gateway.	No

Istio Egress Configuration

Field	Type	Description	Required
`kubernetes`	IstioKubernetes	The Kubernetes resources than can be configured for an Istio egress gateway.	No

Istio Kubernetes Configuration

Field	Type	Description	Required
`replicas`	uint32	The number of pods to replicate.	No
`affinity`	Affinity	A Kubernetes affinity definition.	No

Istio Install Args

Name	Type	ValueType	Description	Required
`gateways.istio-ingressgateway.externalIPs`	NameValue	string list	The external IP address used by the Istio ingress gateway.	No
`gateways.istio-ingressgateway.serviceAnnotations.*`	NameValue	string	Annotations used for the Istio ingress gateway. For sample usage, see Customize Ingress.	No
`meshConfig.enableTracing`	NameValue	string	If `"true"`, Istio will export tracing when Jaeger is installed. Defaults to `"false"`.	No
`meshConfig.defaultConfig.tracing.sampling`	NameValue	string	Sampling rate for Istio tracing. Defaults to `"1"`, meaning a 1% sampling rate.	No

Fluentd Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then Fluentd will be installed.	No
`extraVolumeMounts`	ExtraVolumeMount list	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 of `/var/log`, the Fluentd DaemonSet must have the volume mount of that directory to collect the logs.	No
`elasticsearchURL`	string	The target OpenSearch URLs. Specify this option in this format. The default `http://vmi-system-es-ingest-oidc:8775` is the VMI OpenSearch URL.	No
`elasticsearchSecret`	string	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.	No
`oci`	OCILoggingConfiguration	The Oracle Cloud Infrastructure Logging configuration.	No

Jaeger Operator Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then Jaeger Operator will be installed.	No

Extra Volume Mount

Field	Type	Description	Required
`source`	string	The source host path.	Yes
`destination`	string	The destination path on the Fluentd Container, defaults to the `source` host path.	No
`readOnly`	Boolean	Specifies if the volume mount is read-only, defaults to `true`.	No

Oracle Cloud Infrastructure Logging Configuration

Field	Type	Description	Required
`systemLogId`	string	The OCID of the Oracle Cloud Infrastructure Log that will collect system logs.	Yes
`defaultAppLogId`	string	The OCID of the Oracle Cloud Infrastructure Log that will collect application logs.	Yes
`apiSecret`	string	The name of the secret containing the Oracle Cloud Infrastructure API configuration and private key.	No

Keycloak Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then Keycloak will be installed.	No
`mysql`	MySQLComponent	Contains the MySQL component configuration needed for Keycloak.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

MySQL Component

Field	Type	Description	Required
`volumeSource`	VolumeSource	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.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

OpenSearch Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then OpenSearch will be installed.	No
`installArgs`	OpenSearchInstallArgs list	A list of values to use during OpenSearch installation. Each argument is specified as either a `name/value` or `name/valueList` pair. For sample usage, see Customize OpenSearch.	No
`policies`	Policy list	A list of Index State Management policies to enable on OpenSearch.	No
`nodes`	Node list	A list of OpenSearch node groups.	No

OpenSearch Node Groups

Field	Type	Description	Required
`name`	string	Name of the node group.	Yes
`replicas`	integer	Node group replica count.	No
`roles`	list	Role(s) that nodes in the group will assume. May be `master`, `data`, and/or `ingest`.	Yes
`storage`	Storage	Storage settings for the node group.	No
`resources`	Resources	Kubernetes container resources for nodes in the node group.	No

OpenSearch Node Group Storage

Field	Type	Description	Required
`size`	string	Node group storage size expressed as a Quantity.	Yes

OpenSearch Index Management Policies

Field	Type	Description	Required
`policyName`	string	Name of the Index State Management policy.	Yes
`indexPattern`	string	An Index Pattern is an index name or pattern like `my-index-*`. If an index matches the pattern, the associated policy will attach to the index.	Yes
`minIndexAge`	Time	Amount of time until a managed index is deleted. Default is seven days (`7d`).	No
`rollover`	Rollover	Index rollover settings.	No

OpenSearch Install Args

To configure OpenSearch, instead of using install args, Oracle recommends that you use OpenSearch Node Groups.

Name	Type	ValueType	Description	Required
`nodes.master.replicas`	NameValue	string	The number of master node replicas.	No
`nodes.master.requests.memory`	NameValue	string	The master node memory request amount expressed as a Quantity.	No
`nodes.master.requests.storage`	NameValue	string	The master storage request amount expressed as a Quantity.	No
`nodes.ingest.replicas`	NameValue	string	The number of ingest node replicas.	No
`nodes.ingest.requests.memory`	NameValue	string	The ingest node memory request amount expressed as a Quantity.	No
`nodes.data.replicas`	NameValue	string	The number of data node replicas.	No
`nodes.data.requests.memory`	NameValue	string	The data node memory request amount expressed as a Quantity.	No
`nodes.data.requests.storage`	NameValue	string	The data storage request amount expressed as a Quantity.	No

OpenSearch Index Management Rollover

Field	Type	Description	Required
`minIndexAge`	Time	Amount of time until a managed index is rolled over. Default is 1 day (`1d`).	No
`minSize`	Bytes	The size at which a managed index is rolled over.	No
`minDocCount`	uint32	Amount of documents in a managed index that triggers a rollover.	No

OpenSearch Dashboards Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then OpenSearch Dashboards will be installed.	No

Prometheus Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then Prometheus will be installed.	No

Grafana Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then Grafana will be installed.	No

Kiali Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then Kiali will be installed.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

Prometheus Operator Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then the Prometheus Operator will be installed.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

Prometheus Adapter Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then the Prometheus Adapter will be installed.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

Kube State Metrics Component

Field	Type	Description	Required
`enabled`	Boolean	If true, then kube-state-metrics will be installed.	No
`monitorChanges`	Boolean	If false, then Verrazzano updates will ignore any configuration changes to this component. Defaults to `true`.	No
`overrides`	Overrides list	List of Overrides for the default `values.yaml` file for the component Helm chart. Lower Overrides have precedence over the ones above them. You can find all possible values here and invalid values will be ignored.	No

Overrides

Field	Type	Description	Required
`configMapRef`	ConfigMapKeySelector	Selector for ConfigMap containing override data.	No
`secretRef`	SecretKeySelector	Selector for Secret containing override data.	No
`values`	JSON	Configure overrides using inline YAML.	No

Docs: Verrazzano Workload Custom Resource Definitions

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

VerrazzanoCoherenceWorkload

The VerrazzanoCoherenceWorkload custom resource contains the configuration information for a Coherence workload within Verrazzano. Here is a sample component that specifies a VerrazzanoCoherenceWorkload. To deploy an example application that demonstrates this workload type, see Sock Shop.

apiVersion: core.oam.dev/v1alpha2
kind: Component
metadata:
  name: carts
  namespace: sockshop
spec:
  workload:
    apiVersion: oam.verrazzano.io/v1alpha1
    kind: VerrazzanoCoherenceWorkload
    spec:
      template:
        metadata:
          name: carts-coh
        spec:
          cluster: SockShop
          role: Carts
          replicas: 1
          image: ghcr.io/helidon-sockshop/carts-coherence:2.2.0
          imagePullPolicy: Always
          application:
            type: helidon
          jvm:
            args:
              - "-Dcoherence.k8s.operator.health.wait.dcs=false"
              - "-Dcoherence.metrics.legacy.names=false"
            memory:
              heapSize: 2g
          coherence:
            logLevel: 9
          ports:
            - name: http
              port: 7001
              service:
                name: carts
                port: 80
              serviceMonitor:
                enabled: true
            - name: metrics
              port: 7001
              serviceMonitor:
                enabled: true

VerrazzanoCoherenceWorkload

Field	Type	Description	Required
`apiVersion`	string	`oam.verrazzano.io/v1alpha1`	Yes
`kind`	string	VerrazzanoCoherenceWorkload	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	VerrazzanoCoherenceWorkloadSpec	The desired state of a Verrazzano Coherence workload.	Yes

VerrazzanoCoherenceWorkloadSpec

VerrazzanoCoherenceWorkloadSpec specifies the desired state of a Verrazzano Coherence workload.

Field	Type	Description	Required
`template`	RawExtension	The metadata and spec for the underlying Coherence resource.	Yes

VerrazzanoHelidonWorkload

The VerrazzanoHelidonWorkload custom resource contains the configuration information for a Helidon workload within Verrazzano. Here is a sample component that specifies a VerrazzanoHelidonWorkload. To deploy an example application that demonstrates this workload type, see Hello World Helidon.

apiVersion: core.oam.dev/v1alpha2
kind: Component
metadata:
  name: hello-helidon-component
  namespace: hello-helidon
spec:
  workload:
    apiVersion: oam.verrazzano.io/v1alpha1
    kind: VerrazzanoHelidonWorkload
    metadata:
      name: hello-helidon-workload
      labels:
        app: hello-helidon
    spec:
      deploymentTemplate:
        metadata:
          name: hello-helidon-deployment
        podSpec:
          containers:
            - name: hello-helidon-container
              image: "ghcr.io/verrazzano/example-helidon-greet-app-v1:0.1.10-3-20201016220428-56fb4d4"
              ports:
                - containerPort: 8080
                  name: http

VerrazzanoHelidonWorkload

Field	Type	Description	Required
`apiVersion`	string	`oam.verrazzano.io/v1alpha1`	Yes
`kind`	string	VerrazzanoHelidonWorkload	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	VerrazzanoHelidonWorkloadSpec	The desired state of a Verrazzano Helidon workload.	Yes

VerrazzanoHelidonWorkloadSpec

VerrazzanoHelidonWorkloadSpec specifies the desired state of a Verrazzano Helidon workload.

Field	Type	Description	Required
`deploymentTemplate`	DeploymentTemplate	The embedded deployment.	Yes

DeploymentTemplate

DeploymentTemplate specifies the metadata and pod spec of the underlying deployment.

Field	Type	Description	Required
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`strategy`	DeploymentStrategy	The replacement strategy of the underlying deployment.	No
`podSpec`	PodSpec	The pod spec of the underlying deployment.	Yes

VerrazzanoWebLogicWorkload

The VerrazzanoWebLogicWorkload custom resource contains the configuration information for a WebLogic Domain workload within Verrazzano. Here is a sample component that specifies a VerrazzanoWebLogicWorkload. To deploy an example application that demonstrates this workload type, see the ToDo List Lift-and-Shift application.

apiVersion: core.oam.dev/v1alpha2
kind: Component
metadata:
  name: todo-domain
  namespace: todo-list
spec:
  workload:
    apiVersion: oam.verrazzano.io/v1alpha1
    kind: VerrazzanoWebLogicWorkload
    spec:
      template:
        metadata:
          name: todo-domain
          namespace: todo-list
        spec:
          domainUID: tododomain
          domainHome: /u01/domains/tododomain
          image: container-registry.oracle.com/verrazzano/example-todo:0.8.0
          imagePullSecrets:
            - name: tododomain-repo-credentials
          domainHomeSourceType: "FromModel"
          includeServerOutInPodLog: true
          replicas: 1
          webLogicCredentialsSecret:
            name: tododomain-weblogic-credentials
          configuration:
            introspectorJobActiveDeadlineSeconds: 900
            model:
              configMap: tododomain-jdbc-config
              domainType: WLS
              modelHome: /u01/wdt/models
              runtimeEncryptionSecret: tododomain-runtime-encrypt-secret
            secrets:
              - tododomain-jdbc-tododb
          serverPod:
            env:
              - name: JAVA_OPTIONS
                value: "-Dweblogic.StdoutDebugEnabled=false"
              - name: USER_MEM_ARGS
                value: "-Djava.security.egd=file:/dev/./urandom -Xms64m -Xmx256m "
              - name: WL_HOME
                value: /u01/oracle/wlserver
              - name: MW_HOME
                value: /u01/oracle

VerrazzanoWebLogicWorkload

Field	Type	Description	Required
`apiVersion`	string	`oam.verrazzano.io/v1alpha1`	Yes
`kind`	string	VerrazzanoWebLogicWorkload	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	No
`spec`	VerrazzanoWebLogicWorkloadSpec	The desired state of a Verrazzano WebLogic workload.	Yes

VerrazzanoWebLogicWorkloadSpec

VerrazzanoWebLogicWorkloadSpec specifies the desired state of a Verrazzano WebLogic workload.

Field	Type	Description	Required
`template`	RawExtension	The metadata and spec for the underlying WebLogic Domain resource.	Yes

Docs: VerrazzanoManagedCluster Custom Resource Definition

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

The VerrazzanoManagedCluster custom resource is used to register a managed cluster with an admin cluster. Here is a sample VerrazzanoManagedCluster that registers the cluster named managed1. To deploy an example application that demonstrates a VerrazzanoManagedCluster, see Multicluster Hello World Helidon.

apiVersion: clusters.verrazzano.io/v1alpha1
kind: VerrazzanoManagedCluster
metadata:
  name: managed1
  namespace: verrazzano-mc
spec:
  description: "Managed Cluster 1"
  caSecret: ca-secret-managed1

VerrazzanoManagedCluster

Field	Type	Description	Required
`apiVersion`	string	`clusters.verrazzano.io/v1alpha1`	Yes
`kind`	string	VerrazzanoManagedCluster	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	VerrazzanoManagedClusterSpec	The managed cluster specification.	Yes
`status`	VerrazzanoManagedClusterStatus	The runtime status this resource.	No

VerrazzanoManagedClusterSpec

VerrazzanoManagedClusterSpec specifies a managed cluster to associate with an admin cluster.

Field	Type	Description	Required
`description`	string	The description of the managed cluster.	No
`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. See the pre-registration instructions for how to create this Secret.	Yes
`serviceAccount`	string	The name of the ServiceAccount that was generated for the managed cluster. This field is managed by a Verrazzano Kubernetes operator.	No
`managedClusterManifestSecret`	string	The name of the Secret containing generated YAML manifest file to be applied by the user to the managed cluster. This field is managed by a Verrazzano Kubernetes operator.	No

VerrazzanoManagedClusterStatus

Field	Type	Description	Required
`conditions`	Condition array	The current state of this resource.	No
`lastAgentConnectTime`	string	The last time the agent from this managed cluster connected to the admin cluster.	No
`apiUrl`	string	The Verrazzano API server URL for the managed cluster.	No

Condition

Condition describes current state of this resource.

Field	Type	Description	Required
`type`	string	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.	Yes
`status`	ConditionStatus	An instance of the type ConditionStatus that is defined in types.go.	Yes
`lastTransitionTime`	string	The last time the condition transitioned from one status to another.	No
`message`	string	A message with details about the last transition.	No

Docs: VerrazzanoProject Custom Resource Definition

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

The VerrazzanoProject custom resource is used to create the application namespaces and their associated security settings on one or more clusters. The namespaces are always created on the admin cluster. Here is a sample VerrazzanoProject that specifies a namespace to create on the cluster named managed1.

apiVersion: clusters.verrazzano.io/v1alpha1
kind: VerrazzanoProject
metadata:
  name: hello-helidon
  namespace: verrazzano-mc
spec:
  template:
    namespaces:
      - metadata:
          name: hello-helidon
  placement:
    clusters:
      - name: managed1

VerrazzanoProject

Field	Type	Description	Required
`apiVersion`	string	`clusters.verrazzano.io/v1alpha1`	Yes
`kind`	string	VerrazzanoProject	Yes
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	VerrazzanoProjectSpec	The project specification.	Yes
`status`	MultiClusterResourceStatus	The runtime status of a multicluster resource.	No

VerrazzanoProjectSpec

VerrazzanoProjectSpec specifies the namespaces to create and on which clusters to create them.

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

ProjectTemplate

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

Field	Type	Description	Required
`namespaces`	NamespaceTemplate array	The list of application namespaces to create for this project.	Yes
`security`	SecuritySpec	The project security configuration.	No
`networkPolicies`	NetworkPolicyTemplate array	The network policies applied to namespaces in the project.	No

NamespaceTemplate

NamespaceTemplate contains the metadata and specification of a Kubernetes namespace.

Field	Type	Description	Required
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	NamespaceSpec	An instance of the `struct` NamespaceSpec defined in types.go.	No

SecuritySpec

SecuritySpec defines the security configuration for a project.

Field	Type	Description	Required
`projectAdminSubjects`	Subject	The subject to bind to the `verrazzano-project-admin` role. Encoded as an instance of the `struct` Subject defined in types.go.	No
`projectMonitorSubjects`	Subject	The subject to bind to the `verrazzano-project-monitoring` role. Encoded as an instance of the `struct` Subject defined in types.go.	No

NetworkPolicyTemplate

NetworkPolicyTemplate contains the metadata and specification of the underlying NetworkPolicy.

NOTE

To add an application NetworkPolicy, see NetworkPolicies for applications.

Field	Type	Description	Required
`metadata`	ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.	Yes
`spec`	NetworkPolicySpec	An instance of the `struct` NetworkPolicySpec defined in types.go.	No