Skip to content

Commit

Permalink
Update documentations for Kubeflow Pipelines marketplace (#2125)
Browse files Browse the repository at this point in the history
* fix

* update documentations

* update documentations

* update documentations

* small fixes
  • Loading branch information
IronPan authored Sep 17, 2019
1 parent 0efdb55 commit 6b6b83c
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 13 deletions.
Binary file modified manifests/gcp_marketplace/chart/kubeflow-pipelines/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ metadata:
annotations:
kubernetes-engine.cloud.google.com/icon: >-
data:image/png;base64,{{ .Files.Get "logo.png" | b64enc }}
marketplace.cloud.google.com/deploy-info: '{"partner_id": "click-to-deploy-containers", "product_id": "kubeflow-pipelines", "partner_name": "Google Click to Deploy"}'
marketplace.cloud.google.com/deploy-info: '{"partner_id": "google-cloud-ai-platform", "product_id": "kubeflow-pipelines", "partner_name": "Google Cloud AI Platform"}'
labels:
app.kubernetes.io/name: "{{ .Release.Name }}"
spec:
descriptor:
type: Kubeflow Pipelines
version: '0.2'
description: |-
Machine Learning Pipeline on Kubernetes
Reusable end-to-end ML workflow
maintainers:
- name: Google Click to Deploy
url: https://cloud.google.com/solutions/#click-to-deploy
- name: Google Cloud AI Platform
url: https://cloud.google.com/ai-platform/
- name: Kubeflow Pipelines
url: https://github.com/kubeflow/pipelines
links:
Expand Down
44 changes: 35 additions & 9 deletions manifests/gcp_marketplace/schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Copy link
@ccarpentiere

ccarpentiere Sep 18, 2019

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

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.

Copy link
@ccarpentiere

ccarpentiere Sep 18, 2019

Suggest changing this paragraph to:

[Add a sentence explaining why this is needed - what is it used for?] Provide the instance connection name for an existing Cloud SQL for MySQL instance. The instance connection name can be found on the instance detail page in the Cloud SQL console. The instance connection name uses the format project:zone:instance-name, for example,myproject:us-central1:myinstance. For more details on how to create a new instance, see https://cloud.google.com/sql/docs/mysql/quickstart.

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.

Copy link
@ccarpentiere

ccarpentiere Sep 18, 2019

Suggest changing this to:

The database username to use when connecting to the Cloud SQL instance. If you leave this field empty, the deployment will use the default 'root' user account to connect. For more details about MySQL users, see https://cloud.google.com/sql/docs/mysql/users.

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.

Copy link
@ccarpentiere

ccarpentiere Sep 18, 2019

Need some clarification here. I think what you mean is that if you don't specify a password, the deployment will assume that the specified user account doesn't have one, and will try to connect without one. This will fail if there is actually a password for that user, so I want to make that clear in the help text. Let me know if that's not the case and I'll reword.

Suggest changing this to:

The database password to use when connecting to the Cloud SQL instance. If you leave this field empty, the deployment will try to connect to the instance without providing a password. This will fail if a password is required for the username you provided.

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.

Copy link
@ccarpentiere

ccarpentiere Sep 18, 2019

I'm guessing on the naming requirements as indicated in the text, change as needed.

Suggest changing this to:

The prefix to use when naming the Kubeflow Pipelines databases. Kubeflow Pipelines will create two databases, [prefix]_pipeline and [prefix]_metadata. You can only use lowercase letters, numbers, and hyphens in the prefix, and the prefix must start with a letter. If you specify the same prefix as a previous deployment, this deployment will recover from that deployment. If you don't specify a prefix, the app instance name will be used.

[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
Expand Down

0 comments on commit 6b6b83c

Please sign in to comment.