Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openfun/kubic
A Kubernetes deployment as code to OVH or Scaleway, with Prometheus, ArgoCD and Hashicorp Vault
https://github.com/openfun/kubic
argocd hashicorp-vault kubernetes ovh prometheus scaleway terraform
Last synced: about 1 month ago
JSON representation
A Kubernetes deployment as code to OVH or Scaleway, with Prometheus, ArgoCD and Hashicorp Vault
- Host: GitHub
- URL: https://github.com/openfun/kubic
- Owner: openfun
- License: mit
- Created: 2023-04-18T13:09:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-23T23:16:43.000Z (about 2 months ago)
- Last Synced: 2024-10-24T12:43:35.948Z (about 2 months ago)
- Topics: argocd, hashicorp-vault, kubernetes, ovh, prometheus, scaleway, terraform
- Language: HCL
- Homepage: https://openfun.github.io/kubic/
- Size: 865 KB
- Stars: 37
- Watchers: 8
- Forks: 3
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kubic - Kubernetes Infrastructure as Code
[](https://kubernetes.io)
[](https://kubernetes.github.io/ingress-nginx/)
[](https://argo-cd.readthedocs.io)
[](https://www.vaultproject.io)
[](https://www.terraform.io)
Available on:
[](https://www.scaleway.com)
[](https://www.ovh.com)
## Overview
Kubic is a cutting edge, ready for production and multi cloud provider Kubernetes infrastructure as code. It integates an ingress controller, a certificate manager, a monitoring stack, a GitOps tool with complete secret management and a backup tool.
This Terraform aims at creating a managed k8s cluster setup with :
- NGINX Ingress Controller
- Cert-manager
- Prometheus / Grafana
- ArgoCD
- Hashicorp Vault if needed
- ArgoCD Vault Plugin if Vault is deployed
- Velero for backuping the cluster
The cluster can be deployed either on OVHCloud or on Scaleway. New provider can be added by creating a new folder in the root of the repository, and by following the same architecture as the existing providers.
## Repository architecture
```bash
.
├── docs # Folder containing the documentation
├── state_bucket # Folder containing the Terraform to create a S3 bucket for the Terraform state
├── vault # Folder containing the Terraform to configure Hashicorp Vault
├── common # Folder containing the Terraform which is common to all the providers
├── ovh # Folder declaring Terraform to deploy a cluster on OVHCloud
├── scaleway # Folder declaring Terraform to deploy a cluster on Scaleway
├── examples # Folder containing examples of applications to deploy with ArgoCD
├── .gitignore
├── LICENSE
└── README.md
```
All files contained in the folder `common` are symbolicaly linked in the folders `ovh` and `scaleway` to avoid code duplication.
## Getting started
- Create you cluster:
- [Manual deployment](docs/cluster-manual.md)
- [Automatic deployment](docs/cluster-auto.md)
- [Configure Hashicorp Vault](docs/hashicorp-vault.md)
- [Configure ArgoCD](docs/argocd.md)
- [Configure Velero](docs/velero.md)
- [Standalone use](docs/standalone.md)
## Contributing
Currently, only OVH and Scaleway are supported as providers. Here are the guidelines to add a new provider:
- Create a new folder in the root of the repository, with the name of the provider;
- Create a symlink for all files in `common` to your new folder;
- Create a `terraform.tf` file containing:
- Terraform configuration with a `s3` backend;
- The `helm`, `kubernetes` and `kubectl` providers along with the provider(s) you need, correctly configured;
- A `kubernetes.tf` file creating the cluster, with an output named `kubeconfig` that contains the actual kubeconfig for the cluster;
- A `ingress-nginx.tf` file, deploying the [ingress-nginx ingress controller](https://kubernetes.github.io/ingress-nginx) and configuring it with an external IP (you may need to create a load balancer on your provider). The ingress IP should be a Terraform output named `ingress_ip`;
- This must also create a `null_resource` named `ingress-nginx` that will `depends_on` on the node pool of your cluster (this is to get a consistent dependency chain for Terraform)
- The controller must have at least the following configuration:
```yaml
controller:
metrics:
enabled: true
serviceMonitor:
additionalLabels:
release: prometheus
enabled: true
extraArgs:
enable-ssl-passthrough: true
admissionWebhooks:
timeoutSeconds: 30
```
- Edit the `docker-compose.yaml` and create a service (adapt merely the code) for your provider.