metadata.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 metadata file is used to define blueprint for marketplace offering and deployment schema

apiVersion: blueprints.cloud.google.com/v1alpha1
kind: BlueprintMetadata
metadata:
  name: ai-on-gke
  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
    actuationTool:
      flavor: Terraform
    description: {}
  content: {}
  interfaces:
    variables:
      - name: acknowledge
        varType: bool
        required: true
      - name: iap_consent_info
        description: Configure the <a href="https://developers.google.com/workspace/guides/configure-oauth-consent#configure_oauth_consent"><i>OAuth Consent Screen</i></a> for your project. Ensure <b>User type</b> is set to <i>Internal</i>. Note that by default, only users within your organization can be allowlisted. To add external users, change the <b>User type</b> to <i>External</i> after the application is deployed.
        varType: bool
        defaultValue: false
      - name: add_auth
        description: Enable IAP authentication on jupyterhub
        varType: bool
        defaultValue: false
      - name: additional_labels
        description: Additional labels to add to Kubernetes resources.
        varType: string
        defaultValue: "created-by=gke-ai-quick-start-solutions,ai.gke.io=jupyter"
      - name: autopilot_cluster
        varType: bool
        defaultValue: true
      - name: client_id
        description: Client ID used for enabling IAP
        varType: string
        defaultValue: ""
      - name: client_secret
        description: Client secret used for enabling IAP
        varType: string
        defaultValue: ""
      - name: cluster_name
        varType: string
        defaultValue: "ai-on-gke"
      - name: cluster_location
        varType: string
        required: true
      - name: cluster_membership_id
        description: "require to use connectgateway for private clusters, default: cluster_name"
        varType: string
        defaultValue: ""
      - name: create_brand
        description: Create Brand OAuth Screen
        varType: bool
        defaultValue: false
      - name: create_cluster
        varType: bool
        defaultValue: true
      - name: create_gcs_bucket
        description: Enable flag to create gcs_bucket
        varType: bool
        defaultValue: false
      - name: create_network
        description: Create the VPC specified by network_name/subnetwork_name
        varType: bool
        defaultValue: true
      - name: domain
        description: Domain used for application and SSL certificate.
        varType: string
        defaultValue: "<your JupyterHub domain here>"
      - name: gcs_bucket
        description: Bucket name to store the dataset. The bucket name must be globally unique across google cloud projects
        varType: string
        required: true
      - name: goog_cm_deployment_name
        varType: string
        defaultValue: ""
      - name: k8s_backend_config_name
        description: Name of the Backend Config on GCP
        varType: string
        defaultValue: jupyter-iap-config
      - name: k8s_backend_service_name
        description: Name of the Backend Config on GCP, this is defined by Jupyter hub
        varType: string
        defaultValue: proxy-public
      - name: k8s_backend_service_port
        description: Name of the Backend Service on GCP
        varType: number
        defaultValue: 80
      - name: k8s_iap_secret_name
        varType: string
        defaultValue: jupyter-secret
      - name: k8s_ingress_name
        varType: string
        defaultValue: jupyter-ingress
      - name: k8s_managed_cert_name
        description: Name for frontend managed certificate
        varType: string
        defaultValue: jupyter-managed-cert
      - name: kubernetes_namespace
        description: Kubernetes namespace where resources are deployed
        varType: string
        required: true
        defaultValue: ai-on-gke
      - name: members_allowlist
        description: "For example - user:example@google.com,serviceAccount:serviceAccount@google.com,group:group@google.com,domain:google.com"
        varType: string
        defaultValue: "user:<your-email-here>"
      - name: network_name
        description: Network name of VPC
        varType: string
        defaultValue: net
      - name: private_cluster
        varType: bool
        defaultValue: false
      - name: project_id
        description: GCP project id
        varType: string
        required: true
      - name: subnetwork_cidr
        varType: string
        defaultValue: 10.128.0.0/20
      - name: support_email
        description: Email for users to contact with questions about their consent
        varType: string
        defaultValue: ""
      - name: workload_identity_service_account
        description: workload identity service account
        varType: string
        defaultValue: jupyter-sa
    outputs:
      - name: jupyterhub_ip_address
        description: JupyterHub global IP address
      - name: jupyterhub_password
        description: JupyterHub password is only required for standard authentication. Ignore, in case of IAP authentication
      - name: jupyterhub_uri
        description: JupyterHub Endpoint to access user interface. In case of private IP, consider port-forwarding.
      - name: jupyterhub_user
        description: JupyterHub user is only required for standard authentication. Ignore, in case of IAP authentication
      - name: kubernetes_namespace
        description: Kubernetes namespace
      - name: gke_cluster_name
        description: GKE cluster name where the chat interface, JupyterHub and Ray cluster are running
      - name: gke_cluster_location
        description: GKE cluster location
      - name: project_id
        description: GCP project