README
¶
Lokomotive 
Lokomotive is an open source Kubernetes distribution that ships pure upstream Kubernetes. It focuses on being minimal, easy to use, and secure by default.
Lokomotive is fully self-hosted and includes Lokomotive Components adding essential functionality for production not shipped with upstream Kubernetes.
Features
- Kubernetes 1.19 (upstream, via kubernetes-incubator/bootkube)
- Fully self-hosted, including the kubelet
- Single or multi-master
- Calico networking
- On-cluster etcd with TLS, RBAC-enabled, network policies
Installation
Lokomotive provides the lokoctl CLI tool to manage clusters. Check the installation guide to install it.
Getting started
Follow one of the quickstart guides for the supported platforms:
Documentation
Reference guides
How to guides
- Backup Rook Ceph volume on S3 using Velero
- Kubernetes storage with Rook Ceph on Equinix Metal
- Set up monitoring on Lokomotive
- Setting up an HTTP ingress controller on Lokomotive with MetalLB and Contour on Equinix Metal
- Setting up cluster authentication on Lokomotive with GitHub, Dex and Gangway
- Setting up third party OAuth for Grafana
- Upgrading bootstrap kubelet
- Upgrading etcd
- Using Cloudflare as a DNS provider for Lokomotive
Issues
Please file issues on this repository.
Before filing an issue, please ensure you have searched through / reviewed existing issues.
If an issue or PR you’d like to contribute to is already assigned to someone, please reach out to them to coordinate your work.
If you would like to start contributing to an issue or PR, please request to have it assigned to yourself.
Contributing
Check out our contributing guidelines.
License
Unless otherwise noted, all code in the Lokomotive repository is licensed under the Apache 2.0 license. Some portions of the codebase are derived from other projects under different licenses; the appropriate information can be found in the header of those source files, as applicable.
Directories
¶
| Path | Synopsis |
|---|---|
|
cli
|
|
|
cmd
Package cmd has code for all the subcommands of lokoctl.
|
Package cmd has code for all the subcommands of lokoctl. |
|
cmd/cluster
Package cluster implements lokoctl subcommands logic.
|
Package cluster implements lokoctl subcommands logic. |
|
cmd
|
|
|
Package internal contains the utility functions used across the codebase.
|
Package internal contains the utility functions used across the codebase. |
|
admission-webhook-server
Package admissionwebhookserver contains code for admission webhook.
|
Package admissionwebhookserver contains code for admission webhook. |
|
template
Package template contains the utility functions that help in rendering the go templates.
|
Package template contains the utility functions that help in rendering the go templates. |
|
pkg
|
|
|
assets
Package assets handles Lokomotive assets.
|
Package assets handles Lokomotive assets. |
|
components/aws-ebs-csi-driver
Package awsebscsidriver contains code for the aws-ebs-csi-driver component.
|
Package awsebscsidriver contains code for the aws-ebs-csi-driver component. |
|
components/azure-arc-onboarding
Package azurearconboarding installs the azure-arc-onboarding Lokomotive component.
|
Package azurearconboarding installs the azure-arc-onboarding Lokomotive component. |
|
components/contour
Package contour has code related to deployment of contour component.
|
Package contour has code related to deployment of contour component. |
|
components/dex
Package dex has code related to deployment of dex component.
|
Package dex has code related to deployment of dex component. |
|
components/gangway
Package gangway has code related to deployment of gangway component.
|
Package gangway has code related to deployment of gangway component. |
|
components/httpbin
Package httpbin has code related to deployment of httpbin component.
|
Package httpbin has code related to deployment of httpbin component. |
|
components/inspektor-gadget
Package inspektorgadget contains code for the Inspektor Gadget component.
|
Package inspektorgadget contains code for the Inspektor Gadget component. |
|
components/internal/testutil
Package testutil contains helper functions for component unit tests.
|
Package testutil contains helper functions for component unit tests. |
|
components/istio-operator
Package istiooperator has code related to deployment of istio operator component.
|
Package istiooperator has code related to deployment of istio operator component. |
|
components/linkerd
Package linkerd has code related to deployment of istio operator component.
|
Package linkerd has code related to deployment of istio operator component. |
|
components/metallb
Package metallb has code related to deployment of metallb component.
|
Package metallb has code related to deployment of metallb component. |
|
components/node-problem-detector
Package nodeproblemdetector is code for node-problem-detector.
|
Package nodeproblemdetector is code for node-problem-detector. |
|
components/types
Package types contains common types used by the components.
|
Package types contains common types used by the components. |
|
components/util
Package util package has helper functions for installing/deleting/templatising a helm chart.
|
Package util package has helper functions for installing/deleting/templatising a helm chart. |
|
components/velero/azure
Package azure deals with configuring Velero azure plugin.
|
Package azure deals with configuring Velero azure plugin. |
|
components/velero/openebs
Package openebs deals with configuring Velero openebs plugin.
|
Package openebs deals with configuring Velero openebs plugin. |
|
components/velero/restic
Package restic deals with configuring restic plugin.
|
Package restic deals with configuring restic plugin. |
|
components/web-ui
Package webui contains code for the Web UI component.
|
Package webui contains code for the Web UI component. |
|
helm
Package helm handles Helm-related operations.
|
Package helm handles Helm-related operations. |
|
k8sutil
Package k8sutil provides helper for interacting with Kubernetes API.
|
Package k8sutil provides helper for interacting with Kubernetes API. |
|
oidc
Package oidc configures the Kubernetes API server oidc flags needed for the OIDC-based authentication mechanism.
|
Package oidc configures the Kubernetes API server oidc flags needed for the OIDC-based authentication mechanism. |
|
platform/aks
Package aks is a Platform implementation for creating a Kubernetes cluster using Azure AKS.
|
Package aks is a Platform implementation for creating a Kubernetes cluster using Azure AKS. |
|
platform/equinixmetal
Package equinixmetal provides the implenentation of the Platform interface for Equinix Metal cloud provider.
|
Package equinixmetal provides the implenentation of the Platform interface for Equinix Metal cloud provider. |
|
platform/tinkerbell
Package tinkerbell provides Platform implementation using Tinkerbell provisioning system.
|
Package tinkerbell provides Platform implementation using Tinkerbell provisioning system. |
|
terraform
Package terraform handles the execution of terraform processes to bring up the infrastructure for the Lokomotive cluster.
|
Package terraform handles the execution of terraform processes to bring up the infrastructure for the Lokomotive cluster. |
|
test
|
|
|
ingress
Package ingress contains functions related to testing Ingress endpoints.
|
Package ingress contains functions related to testing Ingress endpoints. |
Click to show internal directories.
Click to hide internal directories.