- Resource: FleetPackage
- ResourceBundleSelector
- ResourceBundleTag
- CloudBuildRepository
- Target
- Fleet
- LabelSelector
- VariantSelector
- FleetPackageInfo
- State
- FleetPackageError
- State
- Methods
Resource: FleetPackage
A FleetPackage resource in the Config Delivery API.
A FleetPackage defines a package through which Kubernetes configuration is deployed to a fleet of Kubernetes clusters.
| JSON representation |
|---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "resourceBundleSelector": { object ( |
| Fields | |
|---|---|
name |
Identifier. Name of the |
createTime |
Output only. Time at which the Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Most recent time at which the Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
labels |
Optional. Labels are attributes that can be set and used by both the user and by Config Delivery. Labels must meet the following constraints:
Both keys and values are additionally constrained to be <= 128 bytes. An object containing a list of |
resourceBundleSelector |
Required. Information specifying the source of Kubernetes configuration to deploy. |
target |
Optional. Configuration to select target clusters to deploy Kubernetes configuration to. |
rolloutStrategy |
Optional. The strategy to use to deploy Kubernetes configuration to clusters. |
variantSelector |
Required. Information specifying how to map a |
info |
Output only. Information containing the rollout status of the |
deletionPropagationPolicy |
Optional. Information around how to handle Kubernetes resources at the target clusters when the |
state |
Optional. The desired state of the fleet package. |
ResourceBundleSelector
Information specifying the source of Kubernetes configuration to deploy.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "resourceBundle": { object ( |
| Fields | |
|---|---|
Source can be a directly pushed ResourceBundle or CloudBuildRepository containing the Kubernetes configuration. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: |
|
resourceBundle |
Information specifying |
cloudBuildRepository |
Information specifying |
| End of mutually exclusive fields. | |
ResourceBundleTag
ResourceBundleTag contains the information to refer to a release for a ResourceBundle.
| JSON representation |
|---|
{ "name": string, "tag": string } |
| Fields | |
|---|---|
name |
Required. Name of the |
tag |
Required. The Git tag for a version of the release in a ResourceBundle. The tag must follow the semantic versioning format vX.Y.Z. |
CloudBuildRepository
CloudBuildRepository contains information about fetching Kubernetes configuration from a CloudBuildRepository.
| JSON representation |
|---|
{ "name": string, "path": string, "tag": string, "serviceAccount": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "variantsPattern": string // End of mutually exclusive fields. } |
| Fields | |
|---|---|
name |
Required. Name of the cloud build repository. Format is projects/{p}/locations/{l}/connections/{c}/repositories/{r}. |
path |
Optional. Path to the directory or file within the repository that contains the Kubernetes configuration. If unspecified, path is assumed to the top level root directory of the repository. |
tag |
Required. Git tag of the underlying git repository. The git tag must be in the semantic version format |
serviceAccount |
Required. Google service account to use in CloudBuild triggers to fetch and store Kubernetes configuration. |
| Specifies configuration for how to find variants in the repository. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
variantsPattern |
Optional. Glob pattern that will be used to find variants in the repository. Examples: |
| End of mutually exclusive fields. | |
Target
The target defines different ways to target set of Kubernetes clusters.
| JSON representation |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"fleet": {
object ( |
| Fields | |
|---|---|
| Target for the fleet package. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
fleet |
GKE fleet information to target rollout of the FleetPackage. |
| End of mutually exclusive fields. | |
Fleet
The fleet where the FleetPackage should be deployed.
| JSON representation |
|---|
{
"project": string,
"selector": {
object ( |
| Fields | |
|---|---|
project |
Required. The host project for the GKE fleet. Format is |
selector |
Optional. Selector allows targeting a subset of fleet members using their labels. |
LabelSelector
A label selector is a label query over a set of resources. An empty label selector matches all objects.
| JSON representation |
|---|
{ "matchLabels": { string: string, ... } } |
| Fields | |
|---|---|
matchLabels |
Optional. Map of {key,value} pairs. Each {key,value} pair must match an existing label key and value exactly in order to satisfy the match. An object containing a list of |
VariantSelector
VariantSelector contains information for selecting a variant in ResourceBundle to deploy to a target cluster.
| JSON representation |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "variantNameTemplate": string // End of mutually exclusive fields. } |
| Fields | |
|---|---|
| strategy for selecting a variant. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: | |
variantNameTemplate |
Required. variantNameTemplate is a template that can refer to variables containing cluster membership metadata such as location, name, and labels to generate the name of the variant for a target cluster. The variable syntax is similar to the unix shell variables. Available variables are If you want to deploy a specific variant, say "default" to all the clusters, you can use "default" (string without any variables) as the variantNameTemplate. |
| End of mutually exclusive fields. | |
FleetPackageInfo
FleetPackageInfo represents the status of the FleetPackage across all the target clusters.
| JSON representation |
|---|
{ "activeRollout": string, "lastCompletedRollout": string, "state": enum ( |
| Fields | |
|---|---|
activeRollout |
Optional. The active rollout, if any. Format is |
lastCompletedRollout |
Optional. The last completed rollout, if any. Format is |
state |
Optional. Output only. The current state of the |
errors[] |
Optional. Output only. Errors encountered during configuration deployment (if any). |
State
Possible values for the FleetPackage state.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Unspecified state. |
ACTIVE |
FleetPackage is active. |
SUSPENDED |
FleetPackage is suspended. |
FAILED |
FleetPackage has failed to reconcile. |
DELETING |
FleetPackage is being deleted. |
FleetPackageError
Information representing an error encountered during rolling out configurations.
| JSON representation |
|---|
{ "errorMessage": string } |
| Fields | |
|---|---|
errorMessage |
Optional. A description of the error. |
State
State indicates the desired state for the fleet package. Unspecified value is equivalent to ACTIVE. If state is set to SUSPENDED, active rollout (if any) will continue but no new rollouts will be scheduled.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
Unspecified state. |
ACTIVE |
FleetPackage is intended to be active. |
SUSPENDED |
FleetPackage is intended to be suspended. |
Methods |
|
|---|---|
|
Creates a new FleetPackage in a given project and location. |
|
Deletes a single FleetPackage. |
|
Gets details of a single FleetPackage. |
|
Lists FleetPackages in a given project and location. |
|
Updates the parameters of a single FleetPackage. |