-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
* fix * update documentations * update documentations * update documentations * small fixes
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -101,33 +101,59 @@ properties: | |
x-google-marketplace: | ||
type: NAMESPACE | ||
serviceAccountCredential: | ||
title: Service Account credentials used to call other GCP services. | ||
title: |- | ||
GCP Service Account credentials used to call other GCP services. | ||
description: |- | ||
To be able to call other GCP services, we need to be | ||
This comment has been minimized.
Sorry, something went wrong. |
||
authenticated. This field is used to store the content of the service account | ||
To be able to call other GCP services from the pipeline, we need to be authenticated. | ||
This field is used to store the content of the service account | ||
JSON file. It can be encoded using base64 instead of messing with JSON format. | ||
To get the encoded credential, run | ||
$ gcloud iam service-accounts keys create application_default_credentials.json --iam-account [your-service-account] && cat application_default_credentials.json | base64 | ||
type: string | ||
default: "" | ||
x-google-marketplace: | ||
type: STRING | ||
managedstorage.enabled: | ||
type: boolean | ||
title: Use managed storage | ||
description: Use Cloud SQL and GCS for storing the data | ||
description: |- | ||
Use Cloud SQL and GCS for storing the data. | ||
Using CloudSQL and GCS provides better reliability and performance, | ||
as well as features such as data backup and usage monitoring. | ||
This is the recommended option especially for production scenarios. | ||
If false, the data will be stored in GCE Persistent Disk. | ||
default: false | ||
managedstorage.cloudsqlInstanceConnectionName: | ||
type: string | ||
title: CloudSQL instance connection name. Format projectId:zone:instanceName | ||
title: CloudSQL instance connection name. Required if use managed storage. | ||
description: |- | ||
Provide a pre-created CloudSQL for MySQL instance. | ||
This comment has been minimized.
Sorry, something went wrong.
ccarpentiere
|
||
The instance connection name can be found in the instance detail page. | ||
For example myproject:us-central1:myinstance. | ||
For more details on how to create a new instance, visit https://cloud.google.com/sql/docs/mysql/quickstart | ||
managedstorage.dbUsername: | ||
type: string | ||
title: database username | ||
title: Database username. (Managed storage only) | ||
description: |- | ||
The database username to connect to the CloudSQL instance. | ||
This comment has been minimized.
Sorry, something went wrong.
ccarpentiere
|
||
If leaveing this field empty, the deployment will use the default 'root' user account. | ||
For more details about mysql username, visit https://cloud.google.com/sql/docs/mysql/users | ||
managedstorage.dbPassword: | ||
type: string | ||
title: database password | ||
title: Database password. (Managed storage only) | ||
description: |- | ||
The database password to connect to the CloudSQL instance. | ||
This comment has been minimized.
Sorry, something went wrong.
ccarpentiere
|
||
If leaveing this field empty, the deployment will use no password. | ||
managedstorage.databaseNamePrefix: | ||
type: string | ||
title: database name prefix | ||
|
||
title: Database name prefix. (Managed storage only) | ||
description: |- | ||
The prefix of the database name. Kubeflow Pipelines will create two databases, | ||
This comment has been minimized.
Sorry, something went wrong.
ccarpentiere
|
||
[prefix]_pipeline and [prefix]_metadata. | ||
Use lowercase letters, numbers, and hyphens. Start with a letter. | ||
If the prefix specified is same as an old deployment in the past, | ||
the deployment will recover from an old deployment. | ||
If this not specified, the app instance name will be used. | ||
required: | ||
- name | ||
- namespace | ||
|
Suggest changing this paragraph to:
This deployment requires a service account to use for authentication when calling other GCP services. Specify the base64-encoded credentials for the service account you want to use. You can get these credentials by running the following command in a terminal window:
$ gcloud iam service-accounts keys create application_default_credentials.json --iam-account [your-service-account] && cat application_default_credentials.json | base64