Multicluster and Verrazzano Project
Packages:
clusters.verrazzano.io/v1alpha1
Resource Types:
- MultiClusterApplicationConfiguration
- MultiClusterComponent
- MultiClusterConfigMap
- MultiClusterSecret
- VerrazzanoProject
MultiClusterApplicationConfiguration
MultiClusterApplicationConfiguration specifies the multicluster application API.
| Field | Description | ||||||
|---|---|---|---|---|---|---|---|
apiVersionstring |
clusters.verrazzano.io/v1alpha1
|
||||||
kindstring |
MultiClusterApplicationConfiguration |
||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||
specMultiClusterApplicationConfigurationSpec |
The desired state of a multicluster application resource.
|
||||||
statusMultiClusterResourceStatus |
The observed state of a multicluster application resource. |
MultiClusterComponent
MultiClusterComponent specifies the MultiCluster Component API.
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersionstring |
clusters.verrazzano.io/v1alpha1
|
||||
kindstring |
MultiClusterComponent |
||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specMultiClusterComponentSpec |
The desired state of a MultiCluster Component resource.
|
||||
statusMultiClusterResourceStatus |
The observed state of a MultiCluster Component resource. |
MultiClusterConfigMap
MultiClusterConfigMap specifies the MultiCluster ConfigMap API.
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersionstring |
clusters.verrazzano.io/v1alpha1
|
||||
kindstring |
MultiClusterConfigMap |
||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specMultiClusterConfigMapSpec |
The desired state of a MultiCluster ConfigMap resource.
|
||||
statusMultiClusterResourceStatus |
The observed state of a MultiCluster ConfigMap resource. |
MultiClusterSecret
MultiClusterSecret specifies the MultiCluster Secret API.
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersionstring |
clusters.verrazzano.io/v1alpha1
|
||||
kindstring |
MultiClusterSecret |
||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specMultiClusterSecretSpec |
The desired state of a MultiCluster Secret resource.
|
||||
statusMultiClusterResourceStatus |
The observed state of a MultiCluster Secret resource. |
VerrazzanoProject
VerrazzanoProject specifies the Verrazzano Projects API.
| Field | Description | ||||
|---|---|---|---|---|---|
apiVersionstring |
clusters.verrazzano.io/v1alpha1
|
||||
kindstring |
VerrazzanoProject |
||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||
specVerrazzanoProjectSpec |
The desired state of a Verrazzano Project resource.
|
||||
statusMultiClusterResourceStatus |
The observed state of a Verrazzano Project resource. |
ApplicationConfigurationTemplate
(Appears on: MultiClusterApplicationConfigurationSpec)
ApplicationConfigurationTemplate has the metadata and embedded spec of the OAM applicationConfiguration resource.
| Field | Description | ||
|---|---|---|---|
metadataEmbeddedObjectMeta |
Metadata describing the application. |
||
specOAM core/v1alpha2.ApplicationConfigurationSpec |
The embedded OAM application specification.
|
Cluster
(Appears on: Placement)
Cluster contains the name of a single cluster.
| Field | Description |
|---|---|
namestring |
The name of a cluster. |
ClusterLevelStatus
(Appears on: MultiClusterResourceStatus)
ClusterLevelStatus describes the status of the multicluster resource in a specific cluster.
| Field | Description |
|---|---|
lastUpdateTimestring |
Last update time of the resource state in this cluster. |
messagestring |
Message details about the status in this cluster. |
namestring |
Name of the cluster. |
stateStateType |
State of the resource in this cluster. |
ComponentTemplate
(Appears on: MultiClusterComponentSpec)
ComponentTemplate has the metadata and embedded spec of the OAM component.
| Field | Description | ||||
|---|---|---|---|---|---|
metadataEmbeddedObjectMeta |
Metadata describing the component. |
||||
specOAM core/v1alpha2.ComponentSpec |
The embedded OAM component specification.
|
Condition
(Appears on: MultiClusterResourceStatus)
Condition describes current state of a multicluster resource.
| Field | Description |
|---|---|
lastTransitionTimestring |
(Optional)
Last time the condition transitioned from one status to another. |
messagestring |
(Optional)
A message with details about the last transition. |
statusKubernetes core/v1.ConditionStatus |
Status of the condition: one of |
typeConditionType |
Type of condition. |
ConditionType
(string alias)
(Appears on: Condition)
ConditionType identifies the condition of the multicluster resource which can be checked with kubectl wait.
ConfigMapTemplate
(Appears on: MultiClusterConfigMapSpec)
ConfigMapTemplate has the metadata and spec of the Kubernetes ConfigMap.
| Field | Description |
|---|---|
binaryDatamap[string][]byte |
Corresponds to the |
datamap[string]string |
Corresponds to the |
immutablebool |
Corresponds to the |
metadataEmbeddedObjectMeta |
Metadata describing the ConfigMap. |
EmbeddedObjectMeta
(Appears on: ApplicationConfigurationTemplate, ComponentTemplate, ConfigMapTemplate, SecretTemplate)
EmbeddedObjectMeta is metadata describing a resource.
| Field | Description |
|---|---|
annotationsmap[string]string |
(Optional)
Annotations for the resource. |
labelsmap[string]string |
(Optional)
Labels for the resource. |
namestring |
(Optional)
Name of the resource. |
namespacestring |
(Optional)
Namespace of the resource. |
MultiClusterApplicationConfigurationSpec
(Appears on: MultiClusterApplicationConfiguration)
MultiClusterApplicationConfigurationSpec defines the desired state of a multicluster application.
| Field | Description |
|---|---|
placementPlacement |
Clusters in which the application is to be created. |
secrets[]string |
(Optional)
List of secrets used by the application. These secrets must be created in the application’s namespace before deploying a MultiClusterApplicationConfiguration resource. |
templateApplicationConfigurationTemplate |
Template containing the metadata and spec for an OAM applicationConfiguration resource. |
MultiClusterComponentSpec
(Appears on: MultiClusterComponent)
MultiClusterComponentSpec defines the desired state of a MultiCluster Component.
| Field | Description |
|---|---|
placementPlacement |
Clusters in which the component is to be created. |
templateComponentTemplate |
Template containing the metadata and spec for an OAM component. |
MultiClusterConfigMapSpec
(Appears on: MultiClusterConfigMap)
MultiClusterConfigMapSpec defines the desired state of a MultiCluster ConfigMap.
| Field | Description |
|---|---|
placementPlacement |
Clusters in which the ConfigMap is to be created. |
templateConfigMapTemplate |
The embedded Kubernetes ConfigMap. |
MultiClusterResourceStatus
(Appears on: MultiClusterApplicationConfiguration, MultiClusterComponent, MultiClusterConfigMap, MultiClusterSecret, VerrazzanoProject)
MultiClusterResourceStatus is the runtime status of a multicluster resource.
| Field | Description |
|---|---|
clusters[]ClusterLevelStatus |
Status information for each cluster. |
conditions[]Condition |
The current state of a multicluster resource. |
stateStateType |
The state of the multicluster resource. State values are case-sensitive and formatted as follows:
|
MultiClusterSecretSpec
(Appears on: MultiClusterSecret)
MultiClusterSecretSpec defines the desired state of a MultiCluster Secret.
| Field | Description |
|---|---|
placementPlacement |
Clusters in which the secret is to be created. |
templateSecretTemplate |
The embedded Kubernetes secret. |
NamespaceTemplate
(Appears on: ProjectTemplate)
NamespaceTemplate contains the metadata and specification of a Kubernetes namespace.
| Field | Description | ||
|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||
specKubernetes core/v1.NamespaceSpec |
The specification of a namespace.
|
NetworkPolicyTemplate
(Appears on: ProjectTemplate)
NetworkPolicyTemplate contains the metadata and specification of a Kubernetes NetworkPolicy.
NOTE
To add an application NetworkPolicy, see NetworkPolicies for applications.| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
metadataKubernetes meta/v1.ObjectMeta |
(Optional)
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||
specKubernetes networking/v1.NetworkPolicySpec |
The specification of a network policy.
|
Placement
(Appears on: MultiClusterApplicationConfigurationSpec, MultiClusterComponentSpec, MultiClusterConfigMapSpec, MultiClusterSecretSpec, VerrazzanoProjectSpec)
Placement contains the name of each cluster where a resource will be located.
| Field | Description |
|---|---|
clusters[]Cluster |
List of clusters. |
ProjectTemplate
(Appears on: VerrazzanoProjectSpec)
ProjectTemplate contains the list of namespaces to create and the optional security configuration for each namespace.
| Field | Description |
|---|---|
namespaces[]NamespaceTemplate |
The list of application namespaces to create for this project. |
networkPolicies[]NetworkPolicyTemplate |
(Optional)
Network policies applied to namespaces in the project. |
securitySecuritySpec |
(Optional)
The project security configuration. |
SecretTemplate
(Appears on: MultiClusterSecretSpec)
SecretTemplate has the metadata and spec of the Kubernetes Secret.
| Field | Description |
|---|---|
datamap[string][]byte |
Corresponds to the data field of the struct Secret defined in types.go. |
metadataEmbeddedObjectMeta |
Metadata describing the secret. |
stringDatamap[string]string |
Corresponds to the |
typeKubernetes core/v1.SecretType |
The type of secret. |
SecuritySpec
(Appears on: ProjectTemplate)
SecuritySpec defines the security configuration for a Verrazzano Project.
| Field | Description |
|---|---|
projectAdminSubjects[]Kubernetes rbac/v1.Subject |
(Optional)
The subjects to bind to the |
projectMonitorSubjects[]Kubernetes rbac/v1.Subject |
(Optional)
The subjects to bind to the |
StateType
(string alias)
(Appears on: ClusterLevelStatus, MultiClusterResourceStatus)
StateType identifies the state of a multicluster resource.
VerrazzanoProjectSpec
(Appears on: VerrazzanoProject)
VerrazzanoProjectSpec defines the desired state of a Verrazzano Project.
| Field | Description |
|---|---|
placementPlacement |
Clusters on which the namespaces are to be created. |
templateProjectTemplate |
The project template. |
Generated with gen-crd-api-reference-docs
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.