Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-gcp.Go to Latest
upbound/provider-gcp@v0.41.2
PatchDeployment
osconfig.gcp.upbound.io
PatchDeployment
upbound/provider-gcp@v0.41.2osconfig.gcp.upbound.io

PatchDeployment is the Schema for the PatchDeployments API. Patch deployments are configurations that individual patch jobs use to complete a patch.

Type

CRD

Group

osconfig.gcp.upbound.io

Version

v1beta1

apiVersion: osconfig.gcp.upbound.io/v1beta1

kind: PatchDeployment

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

PatchDeploymentSpec defines the desired state of PatchDeployment

forProvider
requiredobject
requiredobject

No description provided.

duration
string
array

VM instances to patch. Structure is documented below.

all
boolean
array

Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below.

labels
object
array

Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".

array

Targets any of the VM instances specified. Instances are specified by their URI in the form zones/{{zone}}/instances/{{instance_name}}, projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}, or https://www.googleapis.com/compute/v1/projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}

zones
array
array

Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.

array

Schedule a one-time execution. Structure is documented below.

array

Patch configuration that is applied. Structure is documented below.

apt
array
array

Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below.

array

List of packages to exclude from update.

array

An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.

type
string
goo
array
array

goo update settings. Use this setting to override the default goo patch rules. Structure is documented below.

enabled
boolean
array

The ExecStep to run after the patch update. Structure is documented below.

array

The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
preStep
array
array

The ExecStep to run before the patch update. Structure is documented below.

array

The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below.

array

Only apply updates of these windows update classifications. If empty, all updates are applied. Each value may be one of: CRITICAL, SECURITY, DEFINITION, DRIVER, FEATURE_PACK, SERVICE_PACK, TOOL, UPDATE_ROLLUP, UPDATE.

array

List of packages to exclude from update.

array

An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.

yum
array
array

Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below.

array

List of packages to exclude from update.

array

An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.

minimal
boolean
security
boolean
zypper
array
array

zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below.

array

Install only patches with these categories. Common categories include security, recommended, and feature.

array

List of packages to exclude from update.

array

An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.

array

Install only patches with these severities. Common severities include critical, important, moderate, and low.

withUpdate
boolean
project
string
array

Schedule recurring executions. Structure is documented below.

endTime
string
monthly
array
array

Schedule with monthly executions. Structure is documented below.

monthDay
number
array

Week day in a month. Structure is documented below.

startTime
string
array

Time of the day to run a recurring deployment. Structure is documented below.

hours
number
minutes
number
nanos
number
seconds
number
array

Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below.

id
string
version
string
weekly
array
array

Schedule with weekly executions. Structure is documented below.

dayOfWeek
string
rollout
array
array

Rollout strategy of the patch job. Structure is documented below.

array

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below.

fixed
number
mode
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

duration
string
array

VM instances to patch. Structure is documented below.

all
boolean
array

Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below.

labels
object
array

Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".

array

Targets any of the VM instances specified. Instances are specified by their URI in the form zones/{{zone}}/instances/{{instance_name}}, projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}, or https://www.googleapis.com/compute/v1/projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}

zones
array
array

Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.

array

Schedule a one-time execution. Structure is documented below.

array

Patch configuration that is applied. Structure is documented below.

apt
array
array

Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below.

array

List of packages to exclude from update.

array

An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.

type
string
goo
array
array

goo update settings. Use this setting to override the default goo patch rules. Structure is documented below.

enabled
boolean
array

The ExecStep to run after the patch update. Structure is documented below.

array

The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
preStep
array
array

The ExecStep to run before the patch update. Structure is documented below.

array

The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below.

array

Only apply updates of these windows update classifications. If empty, all updates are applied. Each value may be one of: CRITICAL, SECURITY, DEFINITION, DRIVER, FEATURE_PACK, SERVICE_PACK, TOOL, UPDATE_ROLLUP, UPDATE.

array

List of packages to exclude from update.

array

An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.

yum
array
array

Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below.

array

List of packages to exclude from update.

array

An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.

minimal
boolean
security
boolean
zypper
array
array

zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below.

array

Install only patches with these categories. Common categories include security, recommended, and feature.

array

List of packages to exclude from update.

array

An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.

array

Install only patches with these severities. Common severities include critical, important, moderate, and low.

withUpdate
boolean
project
string
array

Schedule recurring executions. Structure is documented below.

endTime
string
monthly
array
array

Schedule with monthly executions. Structure is documented below.

monthDay
number
array

Week day in a month. Structure is documented below.

startTime
string
array

Time of the day to run a recurring deployment. Structure is documented below.

hours
number
minutes
number
nanos
number
seconds
number
array

Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below.

id
string
version
string
weekly
array
array

Schedule with weekly executions. Structure is documented below.

dayOfWeek
string
rollout
array
array

Rollout strategy of the patch job. Structure is documented below.

array

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below.

fixed
number
mode
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

PatchDeploymentStatus defines the observed state of PatchDeployment.

object

No description provided.

duration
string
id
string
array

VM instances to patch. Structure is documented below.

all
boolean
array

Targets VM instances matching ANY of these GroupLabels. This allows targeting of disparate groups of VM instances. Structure is documented below.

labels
object
array

Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-".

array

Targets any of the VM instances specified. Instances are specified by their URI in the form zones/{{zone}}/instances/{{instance_name}}, projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}, or https://www.googleapis.com/compute/v1/projects/{{project_id}}/zones/{{zone}}/instances/{{instance_name}}

zones
array
array

Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone.

name
string
array

Schedule a one-time execution. Structure is documented below.

array

Patch configuration that is applied. Structure is documented below.

apt
array
array

Apt update settings. Use this setting to override the default apt patch rules. Structure is documented below.

array

List of packages to exclude from update.

array

An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.

type
string
goo
array
array

goo update settings. Use this setting to override the default goo patch rules. Structure is documented below.

enabled
boolean
array

The ExecStep to run after the patch update. Structure is documented below.

array

The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
preStep
array
array

The ExecStep to run before the patch update. Structure is documented below.

array

The ExecStepConfig for all Linux VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

The ExecStepConfig for all Windows VMs targeted by the PatchJob. Structure is documented below.

array

Defaults to [0]. A list of possible return values that the execution can return to indicate a success.

array

A Cloud Storage object containing the executable. Structure is documented below.

localPath
string
array

Windows update settings. Use this setting to override the default Windows patch rules. Structure is documented below.

array

Only apply updates of these windows update classifications. If empty, all updates are applied. Each value may be one of: CRITICAL, SECURITY, DEFINITION, DRIVER, FEATURE_PACK, SERVICE_PACK, TOOL, UPDATE_ROLLUP, UPDATE.

array

List of packages to exclude from update.

array

An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.

yum
array
array

Yum update settings. Use this setting to override the default yum patch rules. Structure is documented below.

array

List of packages to exclude from update.

array

An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields.

minimal
boolean
security
boolean
zypper
array
array

zypper update settings. Use this setting to override the default zypper patch rules. Structure is documented below.

array

Install only patches with these categories. Common categories include security, recommended, and feature.

array

List of packages to exclude from update.

array

An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:' command. This field must not be used with any other patch configuration fields.

array

Install only patches with these severities. Common severities include critical, important, moderate, and low.

withUpdate
boolean
project
string
array

Schedule recurring executions. Structure is documented below.

endTime
string
monthly
array
array

Schedule with monthly executions. Structure is documented below.

monthDay
number
array

Week day in a month. Structure is documented below.

startTime
string
array

Time of the day to run a recurring deployment. Structure is documented below.

hours
number
minutes
number
nanos
number
seconds
number
array

Defines the time zone that timeOfDay is relative to. The rules for daylight saving time are determined by the chosen time zone. Structure is documented below.

id
string
version
string
weekly
array
array

Schedule with weekly executions. Structure is documented below.

dayOfWeek
string
rollout
array
array

Rollout strategy of the patch job. Structure is documented below.

array

The maximum number (or percentage) of VMs per zone to disrupt at any given moment. The number of VMs calculated from multiplying the percentage by the total number of VMs in a zone is rounded up. During patching, a VM is considered disrupted from the time the agent is notified to begin until patching has completed. This disruption time includes the time to complete reboot and any post-patch steps. A VM contributes to the disruption budget if its patching operation fails either when applying the patches, running pre or post patch steps, or if it fails to respond with a success notification before timing out. VMs that are not running or do not have an active agent do not count toward this disruption budget. For zone-by-zone rollouts, if the disruption budget in a zone is exceeded, the patch job stops, because continuing to the next zone requires completion of the patch process in the previous zone. For example, if the disruption budget has a fixed value of 10, and 8 VMs fail to patch in the current zone, the patch job continues to patch 2 VMs at a time until the zone is completed. When that zone is completed successfully, patching begins with 10 VMs at a time in the next zone. If 10 VMs in the next zone fail to patch, the patch job stops. Structure is documented below.

fixed
number
mode
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.