airship/airshipctl
Code Issues Proposed changes
A CLI for managing declarative infrastructure.
2,130 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%
4da8a54887
Go to file
Sirisha Gopigiri 4da8a54887 Separate folders-Create airshipctl cli user guide documentation 
Current modified go code, generates RsT files for each airshipctl
cmd and places them in a folder specific to the airshipctl subcommand.
It also generates the index.rst file for the specific airshipctl
subcommand folders. These generated rst files are appropriate to sphinx,
so that they can be easliy rendered in docs.airshipit.org

Steps to render the document locally

	* Install sphinx: python3 -m pip install sphinx
        * Clone airshipctl: git clone https://github.com/airshipit/airshipctl.git
        * Download current PS: cd airshipctl; git fetch "https://review.opendev.org/airship/airshipctl" refs/changes/50/789250/2 && git checkout -b change-789250-1 FETCH_HEAD
	* Build sphinx html pages: cd docs/source; sphinx-build -b html . _build
	* Run local server: cd _build; python3 -m http.server
	* Open URL to access the page: http://localhost:8000/ navigate to commands section access the document

Relates-To: #280
Change-Id: Ifa1dafc7b296014cc826072ac2c52f4488421352
2021-06-28 10:20:55 +05:30
.github Improve release notes issue selection accuracy 2021-04-22 13:24:43 -05:00
certs Adding the ability to inject certificate authorities into docker image 2020-04-24 15:06:11 -05:00
cmd Separate folders-Create airshipctl cli user guide documentation 2021-06-28 10:20:55 +05:30
docs Separate folders-Create airshipctl cli user guide documentation 2021-06-28 10:20:55 +05:30
krm-functions Merge "Use airshipit/alpine in krm-functions" 2021-06-15 19:39:59 +00:00
manifests Merge "Fix deploying ssh key on worker node" 2021-06-25 21:23:45 +00:00
pkg Merge "Add flags to airshipctl get-kubeconfig cmd" 2021-06-25 21:23:51 +00:00
playbooks Switch gating deployment to phase plan 2021-06-03 19:41:05 +04:00
roles Pass GOPROXY to image build from environment and job 2021-06-09 18:51:08 -05:00
testdata/k8s Remove NameInKubeconf field from Context struct 2021-03-26 19:22:52 -05:00
tests/ansible Reusing apache-server instead of httpd 2020-05-01 03:17:02 +00:00
testutil Add flags to airshipctl get-kubeconfig cmd 2021-06-23 13:41:14 +00:00
tools Add airship container cleanup 2021-06-22 14:49:53 +00:00
zuul.d Switch gating deployment to phase plan 2021-06-03 19:41:05 +04:00
.gitignore Fix typo in .gitignore 2020-05-20 16:07:49 -05:00
.gitreview Gerrit: Add .gitreview file 2019-06-25 08:11:57 -05:00
.golangci.yaml Replace Non-ASCII symbols 2020-08-05 13:22:59 +00:00
.goreleaser.yaml Tweak release binaries 2021-04-29 17:09:23 -05:00
.grenrc.js Github action to create release notes 2020-11-13 15:11:06 -06:00
CONTRIBUTING.md Guideline against very large Gerrit Changes 2020-07-06 20:51:00 +05:00
Dockerfile Pass GOPROXY to image build from environment and job 2021-06-09 18:51:08 -05:00
go.mod Invoke validation container directly via ClientV1 package 2021-05-13 13:12:18 -05:00
go.sum Invoke validation container directly via ClientV1 package 2021-05-13 13:12:18 -05:00
LICENSE Add LICENSE 2019-10-19 14:16:05 -05:00
main.go Refactor airshipctl root command 2020-08-25 17:37:19 -05:00
Makefile Pass GOPROXY to image build from environment and job 2021-06-09 18:51:08 -05:00
README.rst Airship blog series link fix 2020-10-14 21:08:35 +00:00
tox.ini Replace venv with tox for documentation builds 2020-05-08 15:47:41 +00:00
Vagrantfile [#32]: scripts for local run playbooks 2020-02-28 17:24:32 -08:00

README.rst

Airshipctl

Airshipctl is a command-line interface that enables users to manage declarative infrastructure and software.

Airshipctl aims to provide a seamless experience for operators wishing to leverage the best open source options such as the Cluster API, Metal Kubed, Kustomize, and kubeadm by providing a straight forward and easily approachable interface.

This project is the heart of our effort to produce Airship 2.0, which has three main evolutions from Airship 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, reference the Airship blog series.

Contributing

Airshipctl is under active development and welcomes new developers! Please read our developer guide to begin contributing.

We also encourage new contributors and operators alike to join us in our Slack workspace and subscribe to our mailing lists.

You can learn more about Airship on the Airship wiki.