mirror of
https://github.com/pomerium/pomerium.git
synced 2025-05-31 01:47:33 +02:00
deployment: update helm and add quick-start docs (#75)
- adds quick-start documentation for using helm - update helm deployment charts to match outstanding official charts repo.
This commit is contained in:
parent
7c7939cf5b
commit
5284c8c32b
20 changed files with 484 additions and 248 deletions
|
@ -30,7 +30,7 @@ function guideSidebar(title) {
|
|||
{
|
||||
title,
|
||||
collapsable: false,
|
||||
children: ["", "kubernetes", "from-source"]
|
||||
children: ["", "helm", "kubernetes", "from-source"]
|
||||
}
|
||||
];
|
||||
}
|
||||
|
|
72
docs/guide/helm.md
Normal file
72
docs/guide/helm.md
Normal file
|
@ -0,0 +1,72 @@
|
|||
# Helm
|
||||
|
||||
This quickstart will show you how to deploy Pomerium with Helm. For the purpose of this guide, we will be using Google's Kubernetes Engine. However, there are many other ways to work with Kubernetes:
|
||||
|
||||
- [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine/)
|
||||
- [Azure Kubernetes Service](https://azure.microsoft.com/en-us/services/kubernetes-service/)
|
||||
- [Amazon Elastic Kubernetes Service (Amazon EKS)](https://aws.amazon.com/eks/)
|
||||
- [OpenShift Kubernetes](https://www.openshift.com/learn/topics/kubernetes/)
|
||||
- Or locally, with [minikube](https://kubernetes.io/docs/setup/minikube/)
|
||||
|
||||
Most of the following steps should be very similar using any other provider, but may require additional tweaks.
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A [Google Cloud Account](https://console.cloud.google.com/)
|
||||
- A configured [identity provider]
|
||||
- Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
||||
- Install the [Google Cloud SDK](https://cloud.google.com/kubernetes-engine/docs/quickstart)
|
||||
- Install [helm](https://helm.sh/docs/using_helm/)
|
||||
|
||||
## Download
|
||||
|
||||
Retrieve the latest copy of pomerium's source-code by cloning the repository.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/pomerium/pomerium.git $HOME/pomerium
|
||||
```
|
||||
|
||||
## Configure
|
||||
|
||||
Edit the the install command in the [helm_gke.sh script ][./scripts/helm_gke.sh] to match your [identity provider] settings.
|
||||
|
||||
|
||||
Generate a wild-card TLS certificate. If you don't have one handy, the included [script] generates one from [LetsEncrypt].
|
||||
|
||||
## Run
|
||||
|
||||
Run [./scripts/helm_gke.sh] which will:
|
||||
|
||||
1. Provision a new cluster
|
||||
2. Create authenticate, authorize, and proxy [deployments](https://cloud.google.com/kubernetes-engine/docs/concepts/deployment).
|
||||
3. Provision and apply authenticate, authorize, and proxy [services](https://cloud.google.com/kubernetes-engine/docs/concepts/service).
|
||||
4. Configure an ingress, Google's default load balancer.
|
||||
|
||||
```bash
|
||||
sh ./scripts/helm_gke.sh
|
||||
```
|
||||
|
||||
You should see roughly the following in your terminal. Note, provisioning does take a few minutes.
|
||||
|
||||
[]([https://asciinema.org/a/223821](https://asciinema.org/a/YcYC4iZLZi5kCCU5lQIWzFnhV)
|
||||
|
||||
And if you check out Google's Kubernetes Engine dashboard you'll see something like:
|
||||
|
||||

|
||||
|
||||
## Navigate
|
||||
|
||||
Open a browser and navigate to `httpbin.corp.example.com`.
|
||||
|
||||
You should see something like the following in your browser.
|
||||
|
||||

|
||||
|
||||
[./scripts/helm_gke.sh]: ../docs/examples.html#google-kubernetes-engine
|
||||
[example kubernetes files]: ../docs/examples.html#google-kubernetes-engine
|
||||
[helloworld]: https://hub.docker.com/r/tutum/hello-world
|
||||
[httpbin]: https://httpbin.org/
|
||||
[identity provider]: ../docs/identity-providers.md
|
||||
[letsencrypt]: https://letsencrypt.org/
|
||||
[script]: https://github.com/pomerium/pomerium/blob/master/scripts/generate_wildcard_cert.sh
|
|
@ -10,11 +10,6 @@ This quickstart will show you how to deploy Pomerium with Kubernetes. For the pu
|
|||
|
||||
Most of the following steps should be very similar using any other provider.
|
||||
|
||||
:::tip
|
||||
|
||||
Google Cloud Platform has a [free trial with $300 credits](https://cloud.google.com/free/docs/gcp-free-tier).
|
||||
|
||||
:::
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue