Skip to content

Latest commit

 

History

History
278 lines (221 loc) · 11.6 KB

README.md

File metadata and controls

278 lines (221 loc) · 11.6 KB
Raw

not official release not official release not official release not official release

Table of Contents
  1. About The Project
  2. Getting Started
  3. Architecture
  4. Usage
  5. Roadmap
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgments

About The Project

Joli Kluster is a way to deploy a fully operational local production kubernetes cluster based on Kind.

Joli Kluster's goal is to deploy locally a production-ready kubernetes cluster. By ready for production I mean by the implementation of basic technical stack in order to manage:

Demo applications will also be deployed on the cluster. Thanks to Alexwhen.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • macOS
  • Shell Script
  • Docker
  • Terraform
  • Kubernetes

(back to top)

Getting Started

This stack is for Developers, DevOps engineers, Kubernetes Developers and Administrators. There is a lot of prerequisites packages you need to install locally before deploying the full stack. Actually, the stack is only MacOS compatible.

Prerequisites

Packages

Brew - A Package Manager for macOS

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Docker - An open platform for developing, shipping, and running containerized applications

brew install docker

Docker Mac Net Connect - To connect directly to Docker-for-Mac containers via IP address.

# Install via Homebrew
brew install chipmk/tap/docker-mac-net-connect
# Run the service and register it to launch at boot
sudo brew services start chipmk/tap/docker-mac-net-connect

Terraform - An open-source, infrastructure as code software tool.

brew tap hashicorp/tap
brew install hashicorp/tap/terraform

Kubectl - The Kubernetes command-line tool to run commands against Kubernetes clusters.

brew install kubectl

Helm - The Kubernetes package manager.

brew install helm

Gum - A tool for glamorous shell scripts.

brew install gum

Kubeseal - The client-side utility for Bitnami Sealed Secrets.

brew install kubeseal

Kind - A tool for running local Kubernetes clusters using Docker container “nodes".

brew install kind

Gandi - A DNS Provider. The Traefik stack is based on this DNS Provider for SSL implementation and ACME Challenge.

Network & DNS

  1. Create a temp kind cluster to retreive the docker network IPAM information
 # create temp cluster
 kind create cluster --name temp
 # retreive IPAM information for kind network
 docker network inspect --format "{{(index .IPAM.Config 0).Subnet}}" kind
 # note the CIDR Range for your kind cluster (example: 172.18.0.0/16) and delete the temp cluster
 kind delete cluster --name temp

  1. From your kind network IP range, you must pick some IPs addresses for MetalLB. It will allow us to deploy Kubernetes Load Balancer Service type for all our applications reachable outside the cluster (example;: from my master range 172.18.0.0/16, I pick these IPs 172.18.0.150-172.18.0.200. So my first LB will pick the 172.18.0.150 IP address).

  2. Create a A record on your GANDI Provider for your futur Wildcard SAN Certificate. IP addresse should be the first one pick previously (example: 172.18.0.150). This IPs will be used by Ingress Controller Traefik.

  Example for mydomain.com
  Name  : *.sub
  Type  : A
  TTL   : 300
  Value : 172.18.0.150

Installation & Clean

  1. Clone the repo 
    git clone git@github.com:beninanutshell/wam-tf-kind.git
  2. Change your Load Balancer IPs addresses for MetalLB inside the Helm's values.yaml line 29 
    configInline:
  address-pools:
    - name: default
      protocol: layer2
      addresses:
      - 172.18.0.150-172.18.0.200 # change it with your IPs. Here you can see that I reserved 50 IPS for my LB. That"s huge ;)
  3. Go inside the bootstrap folder, make all the shell files executable, play that song and follow the guide. 
    cd bootstrap/
chmod +x *.sh
./0-init.sh
  4. For cleaning your local Environnement, go inside the bootstrap folder and play that song. 
    cd bootstrap/
./6-clean.sh

(back to top)

Architecture

High Level Design

Joli Cluster HLD

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Make a clean README.md file
  • Clean all orphan source files
  • Add Cert Manager for Self Signed Issuer Certificates and remove GANDI lockin
  • Multi-platforme implementation
  • Add license.txt
  • Improve shell scripts and terraform files
    • Comments
    • Outputs for Terraform

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

(back to top)

Contact

Benjamin Coutellier - benjamin.coutellier@gmail.com

Project Link: https://github.com/beninanutshell/wam-tf-kind

(back to top)