A CLI for managing declarative infrastructure.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Vamsi Savaram e40b5ffec5
Add initinfra gating tests
3 years ago
.github Add SECURITY.md 3 years ago
cmd Merge "Organize CLI helper functions" 3 years ago
docs Add simple proxy guidelines 3 years ago
manifests Add initinfra gating tests 3 years ago
pkg Add validation to Redfish media ejection 3 years ago
playbooks Add initinfra gating tests 3 years ago
roles Add initinfra gating tests 3 years ago
testdata/k8s [AIR-97] Adding initinfra subcommand 3 years ago
tests/ansible Substituting redfish-emulator and reverse-proxy with Apache 3 years ago
testutil Add iDRAC ephemeral boot media support 3 years ago
tools Add initinfra gating tests 3 years ago
zuul.d Add initinfra gating tests 3 years ago
.gitignore [#6] Add config init subcommand 3 years ago
.gitreview Gerrit: Add .gitreview file 4 years ago
.golangci.yaml Add copyright for missing files 3 years ago
CONTRIBUTING.md [#39] Add Zuul job for GitHub Issues integration 3 years ago
Dockerfile [#81] makefile to check for unused test data 3 years ago
LICENSE Add LICENSE 3 years ago
Makefile [#81] makefile to check for unused test data 3 years ago
README.md [#37] Change issue tracker info to GitHub Issues 3 years ago
Vagrantfile [#32]: scripts for local run playbooks 3 years ago
go.mod Uplift go-git 3 years ago
go.sum Uplift go-git 3 years ago
main.go Add copyright for missing files 3 years ago

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