feat: Updated documentation for OS Config V1 OsConfigService

PiperOrigin-RevId: 306891012
pull/602/head
Google APIs 5 years ago committed by Copybara-Service
parent cab24c7c9b
commit 6e0ac551e0
  1. 16
      google/cloud/osconfig/v1/patch_deployments.proto
  2. 33
      google/cloud/osconfig/v1/patch_jobs.proto

@ -36,7 +36,7 @@ option ruby_package = "Google::Cloud::OsConfig::V1";
// complete a patch. These configurations include instance filter, package
// repository settings, and a schedule. For more information about creating and
// managing patch deployments, see [Scheduling patch
// jobs](/compute/docs/os-patch-management/schedule-patch-jobs).
// jobs](https://cloud.google.com/compute/docs/os-patch-management/schedule-patch-jobs).
message PatchDeployment {
option (google.api.resource) = {
type: "osconfig.googleapis.com/PatchDeployment"
@ -72,25 +72,21 @@ message PatchDeployment {
}
// Output only. Time the patch deployment was created. Timestamp is in
// <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a>
// text format.
// [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
google.protobuf.Timestamp create_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Time the patch deployment was last updated. Timestamp is in
// <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a>
// text format.
// [RFC3339]("https://www.ietf.org/rfc/rfc3339.txt) text format.
google.protobuf.Timestamp update_time = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The last time a patch job was started by this deployment.
// Timestamp is in
// <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a>
// text format.
// Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text
// format.
google.protobuf.Timestamp last_execute_time = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Sets the time for a one time patch deployment. Timestamp is in
// <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a>
// text format.
// [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
message OneTimeSchedule {
// Required. The desired patch job execution time.
google.protobuf.Timestamp execute_time = 1 [(google.api.field_behavior) = REQUIRED];

@ -28,7 +28,7 @@ option java_package = "com.google.cloud.osconfig.v1";
option php_namespace = "Google\\Cloud\\OsConfig\\V1";
option ruby_package = "Google::Cloud::OsConfig::V1";
// A request message to initiate patching across Google Compute Engine
// A request message to initiate patching across Compute Engine
// instances.
message ExecutePatchJobRequest {
// Required. The project in which to run this patch in the form `projects/*`
@ -109,7 +109,7 @@ message ListPatchJobInstanceDetailsResponse {
// Patch details for a VM instance. For more information about reviewing VM
// instance details, see
// [Listing all VM instance details for a specific patch
// job](/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).
// job](https://cloud.google.com/compute/docs/os-patch-management/manage-patch-jobs#list-instance-details).
message PatchJobInstanceDetails {
// The instance name in the form `projects/*/zones/*/instances/*`
string name = 1 [(google.api.resource_reference) = {
@ -169,7 +169,8 @@ message ListPatchJobsResponse {
// details, use ListPatchJobInstanceDetails.
//
// For more information about patch jobs, see
// [Creating patch jobs](/compute/docs/os-patch-management/create-patch-job).
// [Creating patch
// jobs](https://cloud.google.com/compute/docs/os-patch-management/create-patch-job).
message PatchJob {
option (google.api.resource) = {
type: "osconfig.googleapis.com/PatchJob"
@ -612,7 +613,7 @@ message ExecStepConfig {
// An absolute path to the executable on the VM.
string local_path = 1;
// A Google Cloud Storage object containing the executable.
// A Cloud Storage object containing the executable.
GcsObject gcs_object = 2;
}
@ -627,15 +628,15 @@ message ExecStepConfig {
Interpreter interpreter = 4;
}
// Google Cloud Storage object representation.
// Cloud Storage object representation.
message GcsObject {
// Required. Bucket of the Google Cloud Storage object.
// Required. Bucket of the Cloud Storage object.
string bucket = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Name of the Google Cloud Storage object.
// Required. Name of the Cloud Storage object.
string object = 2 [(google.api.field_behavior) = REQUIRED];
// Required. Generation number of the Google Cloud Storage object. This is used to
// Required. Generation number of the Cloud Storage object. This is used to
// ensure that the ExecStep specified by this PatchJob does not change.
int64 generation_number = 3 [(google.api.field_behavior) = REQUIRED];
}
@ -645,10 +646,16 @@ message GcsObject {
// specified, the patch job targets only VMs with those labels and in those
// zones.
message PatchInstanceFilter {
// Represents a group of VMs that can be identified as having all these
// labels, for example "env=prod and app=web".
// Targets a group of VM instances by using their [assigned
// labels](https://cloud.google.com/compute/docs/labeling-resources). Labels
// are key-value pairs. A `GroupLabel` is a combination of labels
// that is used to target VMs for a patch job.
//
// For example, a patch job can target VMs that have the following
// `GroupLabel`: `{"env":"test", "app":"web"}`. This means that the patch job
// is applied to VMs that have both the labels `env=test` and `app=web`.
message GroupLabel {
// Google Compute Engine instance labels that must be present for a VM
// Compute Engine instance labels that must be present for a VM
// instance to be targeted by this filter.
map<string, string> labels = 1;
}
@ -657,8 +664,8 @@ message PatchInstanceFilter {
// permitted.
bool all = 1;
// Targets VM instances matching at least one of these label sets. This allows
// targeting of disparate groups, for example "env=prod or env=staging".
// Targets VM instances matching ANY of these GroupLabels. This allows
// targeting of disparate groups of VM instances.
repeated GroupLabel group_labels = 2;
// Targets VM instances in ANY of these zones. Leave empty to target VM

Loading…
Cancel
Save