airship/airshipctl
Code Issues Proposed changes
A CLI for managing declarative infrastructure.
630 Commits 3 Branches 0 Tags 380 MiB
Go 85.6%
Shell 9.8%
Dockerfile 1.4%
Jinja 1.3%
Makefile 1.2%
Other 0.7%
5f4193e3f5
Go to file
Zuul 5f4193e3f5 Merge "Fix Lint warnings: Use of basic type string as key"
2020-04-30 02:00:40 +00:00
.github Add SECURITY.md 2020-02-20 16:57:57 -06:00
cmd Add baremetal ejectmedia command 2020-04-28 23:10:36 +00:00
docs Proxy support enhancement 2020-04-28 18:04:55 +00:00
manifests Merge "Removed old v1alpha2 version of CAPI componets" 2020-04-28 17:59:40 +00:00
pkg Merge "Fix Lint warnings: Use of basic type string as key" 2020-04-30 02:00:40 +00:00
playbooks Proxy support enhancement 2020-04-28 18:04:55 +00:00
roles Proxy support enhancement 2020-04-28 18:04:55 +00:00
testdata/k8s Refactored airshipctl config 2020-04-22 19:26:07 -07:00
tests/ansible Substituting redfish-emulator and reverse-proxy with Apache 2020-04-17 15:55:48 +00:00
testutil Add baremetal ejectmedia command 2020-04-28 23:10:36 +00:00
tools Proxy support enhancement 2020-04-28 18:04:55 +00:00
zuul.d Promote docs to docs.airshipit.org/airshipctl 2020-04-29 14:32:19 +00:00
.gitignore [#6] Add config init subcommand 2020-02-17 16:22:10 -06:00
.gitreview Gerrit: Add .gitreview file 2019-06-25 08:11:57 -05:00
.golangci.yaml Add copyright for missing files 2020-04-09 08:35:59 -05:00
CONTRIBUTING.md [#39] Add Zuul job for GitHub Issues integration 2020-03-02 09:49:27 -06:00
Dockerfile [#81] makefile to check for unused test data 2020-03-08 00:05:48 +00:00
go.mod Add template based generator plugin 2020-04-29 23:38:58 +04:00
go.sum Add template based generator plugin 2020-04-29 23:38:58 +04:00
LICENSE Add LICENSE 2019-10-19 14:16:05 -05:00
main.go Add copyright for missing files 2020-04-09 08:35:59 -05:00
Makefile [#81] makefile to check for unused test data 2020-03-08 00:05:48 +00:00
README.md [#37] Change issue tracker info to GitHub Issues 2020-02-12 11:13:14 -06:00
Vagrantfile [#32]: scripts for local run playbooks 2020-02-28 17:24:32 -08:00

README.md

airshipctl

What is airshipctl

The airshipctl project is a CLI tool and Golang library for declarative management of infrastructure and software.

The goal for the project is to provide a seamless experience to operators wishing to leverage the best of breed open source options such as the Cluster API, Metal3-io, Kustomize, Kubeadm, and Argo -- into a straight forward and easily approachable tool.

This project is the heart of the effort to produce Airship 2.0, which has three main evolutions from 1.0:

  • Expand our use of entrenched upstream projects.
  • Embrace Kubernetes Custom Resource Definitions (CRD) – Everything becomes an Object in Kubernetes.
  • Make the Airship control plane ephemeral.

To learn more about the Airship 2.0 evolution, please check out the Airship Blog Series.

Contributing

This project is under heavy active development to reach an alpha state.

New developers should read the contributing guide as well as the developer guide in order to get started.

Architecture

The airshipctl tool is designed to work against declarative infrastructure housed in source control and manage the lifecycle of a site.

architecture diagram

Example Usage

In a nutshell, users of airshipctl should be able to do the following:

  1. Create an airshipctl Airship Configuration for their site - sort of like a kubeconfig file.
  2. Create a set of declarative documents representing the infrastructure (baremetal, cloud) and software.
  3. Run airshipctl document pull to clone the document repositories in your Airship Configuration.
  4. When deploying against baremetal infrastructure, run airshipctl bootstrap isogen to generate a self-contained ISO that can be used to boot the first host in the cluster into an ephemeral Kubernetes node.
  5. When deploying against baremetal infrastructure, run airshipctl bootstrap remotedirect to remotely provision the first machine in the cluster using the generated ISO, providing an ephemeral Kubernetes instance that airshipctl can communicate with for subsequent steps. This ephemeral host provides a foothold in the target environment so we can follow the standard cluster-api bootstrap flow.
  6. Run airshipctl cluster initinfra --clustertype=ephemeral to bootstrap the new ephemeral cluster with enough of the chosen cluster-api provider components to provision the target cluster.
  7. Run airshipctl clusterctl to use the ephemeral Kubernetes host to provision at least one node of the target cluster using the cluster-api bootstrap flow.
  8. Run airshipctl cluster initinfra --clustertype=target to bootstrap the new target cluster with any remaining infrastructure necessary to begin running more complex workflows such as Argo.
  9. Run airshipctl workflow submit sitemanage to run the out of the box sitemanage workflow, which will leverage Argo to handle bootstrapping the remaining infrastructure as well as deploying and/or updating software.

As users evolve their sites declaration, whether adding additional infrastructure, or software declarations, they can re-run airshipctl workflow submit sitemanage to introduce those changes to the site.

Project Resources