Back to Charts

THIS CHART IS DEPRECATED.

stable/gcloud-endpoints/README.md

latest4.5 KB
Original Source

THIS CHART IS DEPRECATED.

Google Cloud Endpoints

Google Cloud Endpoints is an NGINX-based proxy used to develop, deploy, protect, and monitor APIs running on Google Cloud.

Note: This Helm Chart was created using Google documentation, but it is not an officially supported or maintained Google product.

TL;DR;

console
$ helm install stable/gcloud-endpoints --set service=project-id.appspot.com,version=version-number,backend=backendapi.default.svc.cluster.local

Introduction

This chart creates a Google Cloud Endpoints deployment and service on a Kubernetes cluster using the Helm package manager.

Prerequisites

  • Kubernetes cluster on Google Container Engine (GKE)
  • API with Open API (swagger) specification yaml file
  • Deploy your Open API spec using gcloud beta service-management deploy swagger.yaml and note the Project ID and version

Installing the Chart

To install the chart with the release name my-release:

console
$ helm install --name my-release stable/gcloud-endpoints --set service=project-id.appspot.com,version=version-number,backend=backendapi.svc.cluster.local

Tip: List all releases using helm list

Uninstalling the Chart

To uninstall/delete the my-release deployment:

console
$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the Drupal chart and their default values.

ParameterDescriptionDefault
imageEndpoints imageb.gcr.io/endpoints/endpoints-runtime:0.3
imagePullPolicyImage pull policyAlways if image tag is latest, else IfNotPresent
backendBackend API in which to proxy requests
serviceName of the Endpoints service
serviceConfigURLURL to fetch the service configuration
httpPortPort to accept HTTP/1.x connections8080 if http2Port and sslPort are not provided
http2PortPort to accept HTTP/2 connections
sslPortPort to accept HTTPS connections
statusPortPort for status/health (not exposed)8090
versionConfig version of Endpoints service
serviceAccountKeyService account key JSON file
nginxConfigCustom NGINX config file
serviceTypeKubernetes Service typeLoadBalancer
resourcesCPU/Memory resource requests/limitsMemory: 128Mi, CPU: 100m

Specify each parameter using the --set key=value[,key=value] argument to helm install.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

console
$ helm install --name my-release -f values.yaml stable/gcloud-endpoints

Tip: You can use the default values.yaml

Documentation