- 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 A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Most recent time at which the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. 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 kubetnetes 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 |
---|
{ // Union field |
Fields | |
---|---|
Union field source . source can be a directly pushed ResourceBundle or CloudBuildRepository containing the kubernetes configuration. source can be only one of the following: |
|
resourceBundle |
Information specifying |
cloudBuildRepository |
Information specifying |
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. Tag refers to a version of the release in a |
CloudBuildRepository
CloudBuildRepository contains information about fetching Kubernetes configuration from a CloudBuildRepository
.
JSON representation |
---|
{ "name": string, "path": string, "tag": string, "serviceAccount": string, // Union field |
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. |
Union field variants . variants_pattern is the configuration for how to read the repository to find variants. variants can be only one of the following: |
|
variantsPattern |
Optional. variantsPattern is a glob pattern that will be used to find variants in the repository. Examples: "variants/*.yaml", "us-*" |
Target
The target defines different ways to target set of kubernetes clusters.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
fleet |
The GKE fleet information. |
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. matchLabels is a 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 |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
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. |
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. |