Package-level declarations
Types
Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web".
Defines the criteria for selecting VM Instances by OS type.
An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones.
Common configurations for an ExecStep.
A step that runs an executable for a PatchJob.
Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.
Google Cloud Storage object representation.
Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo.
Googet patching is performed by running googet update
.
Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month".
Sets the time for a one time patch deployment. Timestamp is in RFC3339 text format.
A package repository.
Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: apt-get update && apt-get -y install package1 package2 package3
remove: apt-get -y remove package1 package2 package3
Yum install: yum -y install package1 package2 package3
remove: yum -y remove package1 package2 package3
Zypper install: zypper install package1 package2 package3
remove: zypper rm package1 package2
Googet install: googet -noconfirm install package1 package2 package3
remove: googet -noconfirm remove package1 package2 package3
Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance.
Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web".
A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones.
Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs.
Sets the time for recurring patch deployments.
Specifies an artifact available as a Google Cloud Storage object.
Specifies an artifact available via some URI.
Specifies a resource to be used in the recipe.
A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is UPDATED
, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step.
Copies the artifact to the specified path on the instance.
Extracts an archive of the type specified in the specified directory.
Installs a deb via dpkg.
Installs an rpm file via the rpm utility.
An action that can be taken as part of installing or updating a recipe.
Runs a script through an interpreter.
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp
.
Represents a time zone from the IANA Time Zone Database.
Represents one week day in a month. An example is "the 4th Sunday".
Represents a weekly schedule.
Represents a single Yum package repository. This repository is added to a repo file that is stored at /etc/yum.repos.d/google_osconfig.repo
.
Yum patching is performed by executing yum update
. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms.
Represents a single Zypper package repository. This repository is added to a repo file that is stored at /etc/zypp/repos.d/google_osconfig.repo
.
Zypper patching is performed by running zypper patch
. See also https://en.opensuse.org/SDB:Zypper_manual.