metadata.display.yaml

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

## Blueprint display metadata file is used to define blueprint for marketplace offering UI interface that includes different parameters and their properties including title, description, tooltip, etc.

apiVersion: blueprints.cloud.google.com/v1alpha1
kind: BlueprintMetadata
metadata:
  name: ai-on-gke-display
  annotations:
    config.kubernetes.io/local-config: "true"
spec:
  info:
    title: JupyterHub on GKE
    source:
      repo: https://github.com/GoogleCloudPlatform/ai-on-gke
      sourceType: git
      dir: /applications/jupyter
  ui:
    input:
      variables:
        acknowledge:
          name: acknowledge
          title: Check to confirm you enabled Google APIs for your project with this command.
          section: acknowledge
          subtext: |
                  <pre>
                    <code style="background: #f4f4f4;border: 1px solid #ddd; border-left: 3px solid #3367d6; color: #6d6868; font-size: 12px; max-width: 100%; padding: 0.5em 0.5em; display: inline; line-height: 45px;">gcloud services enable serviceusage.googleapis.com cloudresourcemanager.googleapis.com</code>
                  </pre>
          enumValueLabels:
            - label: Confirm that all prerequisites have been met.
              value: "true"
        iap_consent_info:
          name: iap_consent_info
          title: Confirm your OAuth consent screen is configured correctly.
          section: iap_auth
        add_auth:
          name: add_auth
          title: Enable IAP Authentication
          section: iap_auth
        additional_labels:
          name: additional_labels
          title: Additional Labels
          invisible: true
          section: required_config
        autopilot_cluster:
          name: autopilot_cluster
          title: GKE Cluster Type
          section: required_config
          invisible: true
        cluster_name:
          name: cluster_name
          title: GKE cluster name
          section: required_config
        client_id:
          name: client_id
          title: Client Id
          invisible: true
          section: iap_auth
        client_secret:
          name: client_secret
          title: Client Secret
          invisible: true
          section: iap_auth
        cluster_location:
          name: cluster_location
          title: Cluster Location
          section: required_config
          xGoogleProperty:
            type: ET_GCE_REGION
            # specified regions have L4 & T4 GPUs https://cloud.google.com/compute/docs/gpus/gpu-regions-zones#view-using-tools
            gce_region:
              allowlisted_regions: ["asia-east1","asia-southeast1","europe-west1","europe-west4","us-central1","us-east1","us-east4","us-west1","us-west4"]
        cluster_membership_id:
          name: cluster_membership_id
          title: Cluster Membership Id
          invisible: true
          section: required_config
        create_brand:
          name: create_brand
          title: Create Brand
          invisible: true
          section: iap_auth
        create_cluster:
          name: create_cluster
          title: Create GKE Cluster
          section: required_config
          invisible: true
        create_gcs_bucket:
          name: create_gcs_bucket
          title: Create Gcs Bucket
          invisible: true
        create_network:
          name: create_network
          title: Create Network
          invisible: true
        domain:
          name: domain
          title: Domain to host JupyterHub
          section: iap_auth
        gcs_bucket:
          name: gcs_bucket
          title: GCS Bucket
          section: required_config
          xGoogleProperty:
            type: ET_GCS_BUCKET
        goog_cm_deployment_name:
          name: goog_cm_deployment_name
          title: Goog Cm Deployment Name
        k8s_backend_config_name:
          name: k8s_backend_config_name
          title: K8s Backend Config Name
          invisible: true
          section: iap_auth
        k8s_backend_service_name:
          name: k8s_backend_service_name
          title: K8s Backend Service Name
          invisible: true
          section: iap_auth
        k8s_backend_service_port:
          name: k8s_backend_service_port
          title: K8s Backend Service Port
          invisible: true
          section: iap_auth
        k8s_iap_secret_name:
          name: k8s_iap_secret_name
          title: K8s Iap Secret Name
          invisible: true
          section: iap_auth
        k8s_ingress_name:
          name: k8s_ingress_name
          title: K8s Ingress Name
          invisible: true
          section: iap_auth
        k8s_managed_cert_name:
          name: k8s_managed_cert_name
          title: K8s Managed Cert Name
          invisible: true
          section: iap_auth
        kubernetes_namespace:
          name: kubernetes_namespace
          title: Kubernetes Namespace
          invisible: true
          section: required_config
        members_allowlist:
          name: members_allowlist
          title: Allowlist users to access JupyterHub
          section: iap_auth
        network_name:
          name: network_name
          title: Network Name
          invisible: true
        private_cluster:
          name: private_cluster
          title: Private Cluster
          invisible: true
          section: required_config
        project_id:
          name: project_id
          title: Project Id
          invisible: true
        subnetwork_cidr:
          name: subnetwork_cidr
          title: Subnetwork Cidr
          invisible: true
        support_email:
          name: support_email
          title: Support Email
          invisible: true
          section: iap_auth
        workload_identity_service_account:
          name: workload_identity_service_account
          title: GCP Workload Identity Service Account
          invisible: true
          section: required_config
      sections:
        - name: acknowledge
          title: Before you begin
          subtext: 
                This solution deploys a sample <a href="https://github.com/GoogleCloudPlatform/ai-on-gke/blob/release-1.1/applications/jupyter/README.md"><i>JupyterHub</i></a> application on GKE in your project to run your Jupyter notebooks.</br>
        - name: required_config
          title: Required configuration
        - name: iap_auth
          title: Optional authentication with Identity-Aware Proxy
          subtext: With <a href="https://cloud.google.com/iap/docs/enabling-kubernetes-howto"><i>IAP authentication</i></a>, you can control user access to JupyterHub. To use IAP, you will need to do the following:</br>
                  <p>
                  &emsp;&emsp;&#x2022; Identify a domain for JupyterHub, and</br>
                  &emsp;&emsp;&#x2022; Create <a href="https://cloud.google.com/dns/docs/records#add_a_record"<i>DNS A records</i></a> for the domain after the application is deployed.
                  </p>
                  Without IAP, users will need to access the GKE cluster and use port-forward to connect to JupyterHub.
    runtime:
      outputMessage: Deployment can take several minutes to complete.
      suggestedActions:
        - heading: "Step 1: Create DNS A Records for JupyterHub"
          description: If using custom domains for JupyterHub, create DNS A record set (<a href="https://cloud.google.com/dns/docs/records#add_a_record">Google DNS Record Set</a>). Propagation takes 10-15 minutes and logging in won’t succeed until it’s done.
        - heading: "Step 2: Launch JupyterHub"
          description: |-
            <p>
            1&#41; If IAP is disabled, port forward to the JupyterHub service:</br>
            &emsp;&#x2022; Setup <a href="https://cloud.google.com/sdk/docs/install">gcloud</a> in your environment.</br>
            &emsp;&#x2022; Get these values from the Outputs section above: <b>Gke Cluster Name</b>, <b>Gke Cluster Location</b>, <b>Kubernetes Namespace</b> , <b>Project Id</b>, <b>Jupyterhub User</b> and <b>Jupyterhub Password</b> </br>
            &emsp;&#x2022; Get cluster credentials: <pre><code style="background: #f4f4f4;border: 1px solid #ddd; border-left: 3px solid #3367d6; color: #6d6868; font-size: 12px; max-width: 100%; padding: 0.5em 0.5em; display: inline;">gcloud container clusters get-credentials &ltGke Cluster Name&gt --location=&ltGke Cluster Location&gt --project=&ltProject Id&gt</code></pre></br>
            &emsp;&#x2022; Port forward to JupyterHub: <pre><code style="background: #f4f4f4;border: 1px solid #ddd; border-left: 3px solid #3367d6; color: #6d6868; font-size: 12px; max-width: 100%; padding: 0.5em 0.5em; display: inline; line-height: 35px;">kubectl -n &ltKubernetes Namespace&gt port-forward service/proxy-public 3080:80</code></pre> </br>
            &emsp;&#x2022; Go to <b>localhost:3080</b> in a browser and log in with <b>Jupyterhub User</b> and <b>Jupyterhub Password</b>
            </p>
            <p>
            2&#41; If IAP is enabled, log in with your organization's credentials. Troubleshooting access issues:</br>
            &emsp;&#x2022; SSL or cert errors indicate the cert is provisioning which takes up to 20 minutes.</br>
            &emsp;&#x2022; If you're unable to login, go to <a href="https://console.cloud.google.com/security/iap">Google Cloud Platform IAP</a>, select the <b>proxy-public</b> service and add the user with the role <b>IAP-secured Web App User</b>.
            </p>
            <p>3&#41; Once logged in, choose the appropriate preset and execute notebooks. Sample notebooks are provided <a href="https://github.com/GoogleCloudPlatform/ai-on-gke/tree/release-1.1/ray-on-gke/examples/notebooks">here</a></p>
      outputs:
        jupyterhub_ip_address: {}
        jupyterhub_password: {}
        jupyterhub_uri:
          openInNewTab: true
          showInNotification: true
          label: Launch JupyterHub
        jupyterhub_user: {}
        kubernetes_namespace: {}
        gke_cluster_name: {}
        gke_cluster_location: {}
        project_id: {}