diff --git a/CHANGELOG b/CHANGELOG index 64a21a5..5eae41b 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,6 +1,8 @@ 0.0.7 * Initial migration to gorealis v2 +* Implemented first version of create feature which takes in a YAML file. +* Added new noun to fetch status called task. Task also has two subcommands, status and config. 0.0.6 diff --git a/README.md b/README.md index 209d512..f21f6ef 100644 --- a/README.md +++ b/README.md @@ -2,61 +2,12 @@ A light-weight client for [Apache Aurora](https://aurora.apache.org/) built using [gorealis](https://github.com/paypal/gorealis). -## Usage - -``` -A light-weight command line client for use with Apache Aurora built using gorealis. - -Usage: - australis [command] - -Available Commands: - create Create an Aurora Job - fetch Fetch information from Aurora - help Help about any command - kill Kill an Aurora Job - start Start a service, maintenance on a host (DRAIN), a snapshot, or a backup. - stop Stop a service or maintenance on a host (DRAIN). - -Flags: - -a, --caCertsPath string CA certificates path to use. - -c, --clientCert string Client certificate to use to connect to Aurora. - -k, --clientKey string Client key to use to connect to Aurora. - -h, --help help for australis - -i, --insecureSkipVerify Skip verification. - -p, --password string Password to use for API authentication - -s, --scheduler_addr string Aurora Scheduler's address. - -u, --username string Username to use for API authentication - -z, --zookeeper string Zookeeper node(s) where Aurora stores information. - -Use "australis [command] --help" for more information about a command. -``` - -## Sample commands: - -### Fetching current leader -`australis fetch leader [ZK NODE 1] [ZK NODE 2]...[ZK NODE N]` - -### Fetching status/mode of a agent -`australis fetch status [HOST 1] [HOST 2]...[HOST N]` - -### Setting host to DRAIN: -`australis start drain [HOST 1] [HOST 2]...[HOST N]` - -### Taking hosts out of DRAIN (End maintenance): -`australis stop drain [HOST 1] [HOST 2]...[HOST N]` - -### Force a snapshot -`australis force snapshot` - -### Force a backup -`australis force backup` +## Usage +See the [documentation](docs/australis.md) for more information. ## Status Australis is a work in progress and does not support all the features of Apache Aurora. -### Building debian file -From root of the repository run: - -`debuild -d -us -uc -b` \ No newline at end of file +### Building debian package +From the inside of the deb-packaging folder, run [build_deb.sh](deb-packaging/build_deb.sh) \ No newline at end of file diff --git a/cmd/docs.go b/cmd/docs.go new file mode 100644 index 0000000..0752d0d --- /dev/null +++ b/cmd/docs.go @@ -0,0 +1,24 @@ +package cmd + +import ( + "github.com/spf13/cobra" + "github.com/spf13/cobra/doc" +) + +func init() { + rootCmd.AddCommand(docsCmd) +} + +var docsCmd = &cobra.Command{ + Use: "docs", + Short: "Kill an Aurora Job", + PersistentPreRun: func(cmd *cobra.Command, args []string) {}, // We don't need a realis client for this cmd + PersistentPostRun: func(cmd *cobra.Command, args []string) {}, // We don't need a realis client for this cmd + Run: func(cmd *cobra.Command, args []string) { + err := doc.GenMarkdownTree(rootCmd, "./docs") + if err != nil { + log.Fatal(err) + } + }, +} + diff --git a/deb-packaging/Dockerfile b/deb-packaging/Dockerfile index 9be8def..823be68 100644 --- a/deb-packaging/Dockerfile +++ b/deb-packaging/Dockerfile @@ -2,7 +2,7 @@ FROM ubuntu:16.04 RUN apt-get update -y && \ apt-get install -y build-essential devscripts dh-exec dh-make git lintian wget && \ - wget https://dl.google.com/go/go1.11.4.linux-amd64.tar.gz -O /tmp/go.tar.gz + wget https://dl.google.com/go/go1.11.5.linux-amd64.tar.gz -O /tmp/go.tar.gz RUN tar -C /usr/local -xzf /tmp/go.tar.gz diff --git a/deb-packaging/build_deb.sh b/deb-packaging/build_deb.sh new file mode 100644 index 0000000..6906d3d --- /dev/null +++ b/deb-packaging/build_deb.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +docker build . -t australis_deb_builder + +docker run --rm -v $HOME/go/pkg/mod:/go/pkg/mod -v $(pwd)/..:/australis australis_builder diff --git a/debian/changelog b/debian/changelog index d7c9287..8ffbd17 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,6 +1,8 @@ australis (0.0.7) unstable; urgency=medium * Upgraded australis to gorealis v2. + * Implemented first version of create feature which takes in a YAML file. + * Added new noun to fetch status called task. Task also has two subcommands, status and config. -- Renan DelValle Wed, 26 Dec 2018 15:10:00 -0700