Add CLI instructions as required by the Marketplace

The Marketplace requires us to give a "Deploy documentation URL" that
details the steps for installing the solution from the command line.

Signed-off-by: Maël Valais <[email protected]>

Author: maelvls

README.md

@@ -1,17 +1,159 @@
-
-# jsp-gcm
-
-This is the repository that holds the configuration for our Google
-Marketplace solution, [jetstack-secure-for-cert-manager][].
-
-**Content:**
-
+# Jetstack Secure for cert-manager on the Google Cloud Marketplace
+
+<!--
+Inspiration:
+https://github.com/unleash-hosted/unleash-hosted-gcp-marketplace/blob/master/README.md
+-->
+
+## Overview of Jetstack Secure for cert-manager
+
+TODO: description of jetstack secure
+
+**Contents:**
+
+- [Overview of Jetstack Secure for cert-manager](#overview-of-jetstack-secure-for-cert-manager)
+- [Installation](#installation)
+  - [Quick install with Google Cloud Marketplace](#quick-install-with-google-cloud-marketplace)
+  - [Command line instructions](#command-line-instructions)
+    - [Prerequisites](#prerequisites)
+      - [Set up command line tools](#set-up-command-line-tools)
+      - [Create a Google Kubernetes Engine cluster](#create-a-google-kubernetes-engine-cluster)
+      - [Configure kubectl to connect to the cluster](#configure-kubectl-to-connect-to-the-cluster)
+      - [Clone this repo](#clone-this-repo)
+      - [Install the Application resource definition](#install-the-application-resource-definition)
+    - [Install the application](#install-the-application)
+      - [Configure the application with environment variables](#configure-the-application-with-environment-variables)
 - [Technical considerations](#technical-considerations)
 - [Installing and manually testing the deployer](#installing-and-manually-testing-the-deployer)
 - [Testing and releasing the deployer using Google Cloud Build](#testing-and-releasing-the-deployer-using-google-cloud-build)
   - [Debugging deployer and smoke-tests when run in Cloud Build](#debugging-deployer-and-smoke-tests-when-run-in-cloud-build)
 - [Updating the upstream cert-manager chart version](#updating-the-upstream-cert-manager-chart-version)
 
+## Installation
+
+### Quick install with Google Cloud Marketplace
+
+Get up and running with a few clicks! Install the Jetstack Secure for
+cert-manager application to a Google Kubernetes Engine cluster using Google
+Cloud Marketplace. Follow the [on-screen
+instructions](https://console.cloud.google.com/marketplace/details/jetstack/jetstack-secure-for-cert-manager).
+
+### Command line instructions
+
+You can use [Google Cloud Shell](https://cloud.google.com/shell/) or a
+local workstation to complete these steps.
+
+[![Open in Cloud Shell](http://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/jetstack/jsp-gcm&cloudshell_working_dir=/)
+
+#### Prerequisites
+
+##### Set up command line tools
+
+You'll need the following tools in your environment. If you are using Cloud Shell, these tools are installed in your environment by default.
+
+- [gcloud](https://cloud.google.com/sdk/gcloud/)
+- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
+- [docker](https://docs.docker.com/install/)
+- [openssl](https://www.openssl.org/)
+- [helm](https://helm.sh/docs/using_helm/#installing-helm)
+- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+
+Configure `gcloud` as a Docker credential helper:
+
+```sh
+gcloud auth configure-docker
+```
+
+##### Create a Google Kubernetes Engine cluster
+
+The [workload
+identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity)
+must be enabled on your cluster. To create a cluster that has _workload
+identity_ feature enabled, run the following command:
+
+```sh
+export CLUSTER=jetstack-cluster
+export ZONE=europe-west1-c
+
+gcloud container clusters create $CLUSTER --zone $ZONE \
+  --workload-pool=$(gcloud config get-value project | tr ':' '/').svc.id.goog
+```
+
+> For an existing cluster, you can turn the feature on (will restart the
+> GKE control plane) with the following command:
+>
+> ```sh
+> gcloud container clusters update $CLUSTER --zone $ZONE \
+>   --workload-pool=$(gcloud config get-value project | tr ':' '/').svc.id.goog
+> ```
+
+##### Configure kubectl to connect to the cluster
+
+```sh
+gcloud container clusters get-credentials "$CLUSTER" --zone "$ZONE"
+```
+
+##### Clone this repo
+
+Clone this repo and the associated tools repo:
+
+```shell
+git clone https://github.com/jetstack/jsp-gcm
+cd jsp-gcm
+```
+
+##### Install the Application resource definition
+
+An Application resource is a collection of individual Kubernetes
+components, such as Services, Deployments, and so on, that you can manage
+as a group.
+
+To set up your cluster to understand Application resources, run the
+following command:
+
+```sh
+kubectl apply -f "https://raw.githubusercontent.com/GoogleCloudPlatform/marketplace-k8s-app-tools/master/crd/app-crd.yaml"
+```
+
+You need to run this command once for each cluster.
+
+The Application resource is defined by the [Kubernetes
+SIG-apps](https://github.com/kubernetes/community/tree/master/sig-apps)
+community. The source code can be found on
+[github.com/kubernetes-sigs/application](https://github.com/kubernetes-sigs/application).
+
+#### Install the application
+
+##### Configure the application with environment variables
+
+Choose an instance name and
+[namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)
+for the application. In most cases, you can use the `default` namespace.
+
+```shell
+export APP_INSTANCE_NAME=jetstack-secure-1
+export NAMESPACE=default
+```
+
+Set up the image tag:
+
+It is advised to use a stable image reference which you can find on
+[Marketplace Container Registry](marketplace.gcr.io/jetstack-public/jetstack-secure-for-cert-manager).
+
+Example:
+
+```shell
+export TAG="1.1.0-gcm.1"
+```
+
+where `1.1.0` stands for the cert-manager version, and `gcm.1` is the
+Google Marketplace build version.
+
+---
+
+This is the repository that holds the configuration for our Google
+Marketplace solution, [jetstack-secure-for-cert-manager][].
+
 ## Technical considerations
 
 **Retagging cert-manager images:**