A CLI for managing declarative infrastructure.
Go to file
Alan Meadows 7eeb529053 Initial commit for document pkg library
This introduces two new interfaces to airshipctl:

* Bundle: represents a Kustomize rendered
collection of your documents that allows you to
iterate over or filter the documents in the bundle.

* Document: a thin wrapper around a rendered
document.

This commit also includes a proposal for a way to
represent YAML test fixtures as testdatafs.go
and a new testdata subfolder within the document
pkg.

Change-Id: I4282b27977617552c25c5ae2c3b7da44e67dd014
2019-10-04 14:22:26 -07:00
cmd Merge "[AIR-97] Adding base airshipctl cluster command" 2019-10-03 16:12:30 +00:00
docs Rename module to reflect its new location 2019-07-01 12:15:29 -05:00
pkg Initial commit for document pkg library 2019-10-04 14:22:26 -07:00
playbooks CI: Add a functional test for interacting with a existing k8s cluster 2019-07-09 21:04:15 +00:00
testutil Initial commit for document pkg library 2019-10-04 14:22:26 -07:00
tools Fix the coverage tests 2019-10-02 15:18:56 -05:00
zuul.d Add Zull job for mirroring to GitHub 2019-07-16 16:50:49 -05:00
.gitignore Remove old .gitignores 2019-06-06 09:30:51 -05:00
.gitreview Gerrit: Add .gitreview file 2019-06-25 08:11:57 -05:00
.golangci.yaml Initial commit for document pkg library 2019-10-04 14:22:26 -07:00
Dockerfile Move up to go 1.13.1 2019-10-04 15:31:45 +00:00
go.mod Initial commit for document pkg library 2019-10-04 14:22:26 -07:00
go.sum Initial commit for document pkg library 2019-10-04 14:22:26 -07:00
main.go Rename module to reflect its new location 2019-07-01 12:15:29 -05:00
Makefile Move up to go 1.13.1 2019-10-04 15:31:45 +00:00
README.md Rename module to reflect its new location 2019-07-01 12:15:29 -05:00

airshipctl

Custom Plugins Tutorial

This tutorial walks through a very basic plugin for airshipctl. For a more involved example, see Plugin Support

The following steps will get you started with a very rudimentary example plugin for airshipctl. First, create a directory for your project outside of the GOPATH:

mkdir /tmp/example
cd /tmp/example

This project will need to be a go module. You can initialize a module named example with the following:

go mod init example

Note that modules are a relatively new feature added to Go, so you'll need to be running Go1.11 or greater. Also note that most modules will follow a naming schema that matches the remote version control system. A more realistice module name might look something like opendev.org/airship/exampleplugin.

Next, create a file main.go and populate it with the following:

package main

import (
	"fmt"
	"os"

	"opendev.org/airship/airshipctl/cmd"
	"github.com/spf13/cobra"
)

func main() {
	rootCmd, _, err := cmd.NewRootCmd(os.Stdout)
	if err != nil {
		fmt.Fprintf(os.Stderr, "Failed to create root airshipctl command: %s\n", err.Error())
		os.Exit(1)
	}

	exampleCmd := &cobra.Command{
		Use:   "example",
		Short: "an example plugin",
		Run: func(cmd *cobra.Command, args []string) {
			fmt.Fprintln(os.Stdout, "Hello airshipctl!")
		},
	}

	rootCmd.AddCommand(exampleCmd)
	if err := rootCmd.Execute(); err != nil {
		fmt.Fprintf(os.Stderr, "Failure during execution: %s\n", err.Error())
		os.Exit(1)
	}
}

And finally, run the build command to download and compile airshipctl:

go build -o airshipctl

Now that you've built airshipctl, you can access your plugin with the following command:

./airshipctl example

You may have noticed that this example ignores the second return value from cmd.NewRootCmd. This value is a pointer to the AirshipCTLSettings, which contains various configuration details, such as the debug flag and the path to the config file*. A useful paradigm involves embedding this object into a custom ExampleSettings struct. This can be seen in the demo repo.

For a more involved example, see Plugin Support

* Work in progress