Skip to content

Commit

Permalink
docs(components): internal
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 621215497
  • Loading branch information
Googler committed Apr 2, 2024
1 parent df20088 commit 2903afa
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 53 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ option java_multiple_files = true;

message TemplateMetadata {
IOMetadata io_metadata = 1;
ValidationItems preflight_validations = 2;
}

message IOMetadata {
Expand Down Expand Up @@ -41,7 +42,8 @@ message Section {

message Input {
// The name of the input.
// Corresponds to parameter/artifact name in ComponentSpec.input_definitions (https://github.com/kubeflow/pipelines/blob/066f229e27dc2ac8a58a03d7745d5471d718157c/api/v2alpha1/pipeline_spec.proto#L353-L357).
// Corresponds to parameter/artifact name in ComponentSpec.input_definitions
// (https://github.com/kubeflow/pipelines/blob/066f229e27dc2ac8a58a03d7745d5471d718157c/api/v2alpha1/pipeline_spec.proto#L353-L357).
string name = 1;
// The display name for the input. Typically a human-readable version of the
// input parameter name.
Expand Down Expand Up @@ -229,3 +231,61 @@ enum UriType {
BIGQUERY_URI = 4;
}
// END: inner messages for top-level types

// Describes the details of validation items.
message ValidationItems {
// Validation for Google Cloud Service Account.
repeated GoogleCloudServiceAccountValidation sa_validations = 1;
// Validation for Google Cloud Project Quota.
repeated GoogleCloudProjectQuotaValidation quota_validations = 2;
// Validation for Google Cloud Api Enablement.
repeated GoogleCloudApiEnablementValidation api_validations = 3;
}

// Describes the details for Google Cloud Project Quota Validation.
message GoogleCloudProjectQuotaValidation {
// Required. Metric name of the quota. Example: "compute.googleapis.com/cpus"
string metric_name = 1;
// Required. Value of the quota demand. Example: 2 or 3.5
// We will validate if the demand is under the limit or not.
oneof value {
// A signed 64-bit integer value.
int64 int64_value = 2;
// A double precision floating point value.
double double_value = 3;
}
}

// Describes the details for Google Cloud Service Account Validation.
message GoogleCloudServiceAccountValidation {
// Required. Default principal email of the service account used for
// validation. Example:
// "{{$.pipeline_google_cloud_project_id}}-compute@developer.gserviceaccount.com"
// Use placeholder to specify the dynamic value like project id.
string default_principal_email = 1;

// Optional. If specified, the principal email will be overridden based on the
// placeholder. Currently support two placeholders: 1.
// "{{$.pipeline_google_cloud_service_account}}"(actual value is from
// PipelineJob.service_account 2.
// "{{$.parameter.service_account}}"(actual value is from the input parameter
// of the component/pipeline). If the value doesn't exist or is empty,
// overriding won't happen.
string override_placeholder = 2;

// Optional. Permission required to have for the service account.
// Pipeline service will check if provided SA has these permissions.
// Example: "aiplatform.metadataStores.get"
repeated string permissions = 3;

// Optional. Roles need to be granted for the service account.
// The role names will occur in preflight validations' error message
// as an action item for users.
repeated string role_names = 4;
}

// Describes the details of Google Cloud Api Enablement Validation.
message GoogleCloudApiEnablementValidation {
// Required. Service names of Google Cloud Api.
repeated string service_names = 1;
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2903afa

Please sign in to comment.