Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/digitalocean/Kubernetes-Starter-Kit-Developers

Hands-on tutorial and Automation stack for an operations-ready DigitalOcean Kubernetes (DOKS) cluster.
https://github.com/digitalocean/Kubernetes-Starter-Kit-Developers

Last synced: 7 days ago
JSON representation

Hands-on tutorial and Automation stack for an operations-ready DigitalOcean Kubernetes (DOKS) cluster.

Awesome Lists containing this project

README 

        
# Day-2 Operations-ready DigitalOcean Kubernetes (DOKS) for Developers



[Webinar video from 9/28/2021](https://www.youtube.com/watch?v=C48gUklH1DU&t=5s)



[Automating GitOps and Continuous Delivery With DigitalOcean Kubernetes](https://www.youtube.com/watch?v=zNfbjpOQRxQ&t=3s)



In this tutorial, we provide developers a hands-on introduction on how to get started with an operations-ready Kubernetes cluster on DigitalOcean Kubernetes (DOKS). Kubernetes is easy to set up and developers can use identical tooling and configurations across any cloud. Making Kubernetes operationally ready requires a few more tools to be set up, which are described in this tutorial.



Resources used by the Starter Kit include the following:



- DigitalOcean `Droplets` (for `DOKS` cluster).

- DigitalOcean `Load Balancer`.

- DigitalOcean `Block Storage` for persistent storage.

- DigitalOcean `Spaces` for object storage.

- Kubernetes Helm Charts:



    [![ingress-nginx](https://img.shields.io/static/v1?label=ingress-nginx&message=4.0.13&color=success)](https://artifacthub.io/packages/helm/ingress-nginx/ingress-nginx/4.0.13)

    [![ingress-ambassador](https://img.shields.io/static/v1?label=ingress-ambassador&message=7.2.2&color=success)](https://artifacthub.io/packages/helm/datawire/edge-stack/7.2.2)

    [![prometheus-stack](https://img.shields.io/static/v1?label=prometheus-stack&message=30.0.1&color=success)](https://artifacthub.io/packages/helm/prometheus-community/kube-prometheus-stack/30.0.1)

    [![loki-stack](https://img.shields.io/static/v1?label=loki-stack&message=2.5.1&color=success)](https://artifacthub.io/packages/helm/grafana/loki-stack/2.5.1)

    [![velero](https://img.shields.io/static/v1?label=velero&message=2.27.3&color=success)](https://artifacthub.io/packages/helm/vmware-tanzu/velero/2.27.3)

    ![triliovault](https://img.shields.io/static/v1?label=triliovault&message=2.6.3&color=success)

    [![sealed-secrets](https://img.shields.io/static/v1?label=sealed-secrets&message=2.1.6&color=success)](https://artifacthub.io/packages/helm/bitnami-labs/sealed-secrets/2.1.6)



**Notes:**



- Main branch should generally work. Just note that it is being frequently updated. If you want to be safe, pick a specific tag version corresponding to DOKS release (eg. v1.21.3, v1.21.5).

- Tags specific points in a repository’s history when an important change applied.



Remember to verify and delete the resources at the end of the tutorial, if you no longer need those.



## Operations-ready Setup Overview



Below is a diagram that gives a high-level overview of the `Starter Kit` setup, as well as the main steps:



![Setup Overview](assets/images/starter_kit_arch_overview.png)



## Table of Contents



1. [Scope](#scope)

2. [Set up DO Kubernetes](01-setup-DOKS/README.md)

3. [Set up DO Container Registry](02-setup-DOCR/README.md)

4. [Set up Ingress Controller](03-setup-ingress-controller/README.md)

   - [Ambassador](03-setup-ingress-controller/ambassador.md)

   - [Nginx](03-setup-ingress-controller/nginx.md)

5. [Set up Observability](04-setup-observability/README.md)

    - [Prometheus Monitoring Stack](04-setup-observability/prometheus-stack.md)

    - [Logs Aggregation via Loki Stack](04-setup-observability/loki-stack.md)

    - [Kubernetes Events Exporter](04-setup-observability/event-exporter.md)

    - [Alerts and Notifications](04-setup-observability/alerts-and-notifications.md)

6. [Set up Backup and Restore](05-setup-backup-restore/README.md)

   - [Trilio](05-setup-backup-restore/trilio.md)

   - [Velero](05-setup-backup-restore/velero.md)

7. [Kubernetes Secrets](06-kubernetes-secrets/README.md)

    - [Sealed Secrets](06-kubernetes-secrets/sealed-secrets.md)

    - [External Secrets Operator](06-kubernetes-secrets/external-secrets-operator.md)

8. [Scaling Application Workloads](07-scaling-application-workloads/README.md)

   - [Horizontal Pod Autoscaling](07-scaling-application-workloads/hpa.md)

   - [Vertical Pod Autoscaling](07-scaling-application-workloads/vpa.md)

9. [Continuous Delivery using GitOps](14-continuous-delivery-using-gitops/README.md)

    - [Argo CD](14-continuous-delivery-using-gitops/argocd.md)

    - [Flux CD](14-continuous-delivery-using-gitops/fluxcd.md)

10. [Estimate Resource Usage of Starter Kit](15-starter-kit-resource-usage/README.md)



## Scope



This tutorial demonstrates the basic setup you need to be operations-ready.



All the steps are done manually using the `command line interface` (CLI). If you need end-to-end automation, refer to the last section.



None of the installed tools are exposed using `Ingress` or `Load Balancer`. To access the console for individual tools, we use `kubectl port-forward`.



We will use `brew` (on MacOS) to install the required command-line utilities on our local machine and use the command to work on a `DOKS` cluster.



For every `service` that gets `deployed`, we will enable `metrics` and `logs`. At the end, we will review the `overhead` from all these additional tools and services. That gives an idea of what it takes to be `operations-ready` after your first cluster install.



This tutorial will use manifest files from this repo. It is recommended to clone this repository to your local environment. The below command can be used to clone this repository.



```shell

git clone https://github.com/digitalocean/Kubernetes-Starter-Kit-Developers.git



git checkout    # If you want to pick a tested tag corresponding to DOKS release, eg. v1.21.3

```



**Notes:**



- For this `Starter Kit`, we recommend to start with a node pool of higher capacity nodes (say, `4cpu/8gb RAM`) and have at least `2` nodes. Otherwise, review and allocate node capacity if you run into pods in `PENDING` state.

- We customize the value files for `Helm` installs of individual components. To get the original value file, use `helm show values`. For example: `helm show values prometheus-community/kube-prometheus-stack  --version 30.0.1`.

- There are multiple places where you will change a manifest file to include a secret token for your cluster. Please be mindful of `handling` the `secrets`, and do not `commit` to `public Git` repositories. A safer method to use is `Sealed Secrets` or `External Secrets Operator`, explained in [Kubernetes Sealed Secrets](06-kubernetes-secrets/README.md). The sample manifests provided in the [Section 14 - Continuous Delivery using GitOps](14-continuous-delivery-using-gitops/README.md) section, shows you how to use `Sealed Secrets` in combination with `Flux CD`, and reference `sensitive` data in each manifest that require secrets.

- To keep the components up to date, helm provides you the option to upgrade them to latest version or desired version. For example `helm upgrade kube-prom-stack prometheus-community/kube-prometheus-stack --version 30.0.0 --namespace monitoring -f "04-setup-prometheus-stack/assets/manifests/prom-stack-values-v30.0.1.yaml"`.



If you want to automate installation for all the components, refer to [Section 14 - Continuous Delivery using GitOps](14-continuous-delivery-using-gitops/README.md).



Go to [Section 1 - Set up DigitalOcean Kubernetes](01-setup-DOKS/README.md).