diff --git a/.goreleaser.yml b/.goreleaser.yml index 34860d8..26c8020 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -1,9 +1,11 @@ -# This is an example goreleaser.yaml file with some sane defaults. + # Make sure to check the documentation at http://goreleaser.com before: hooks: # you may remove this if you don't use vgo - go mod download +release: + prerelease: auto builds: - env: - CGO_ENABLED=0 @@ -29,5 +31,5 @@ changelog: sort: asc filters: exclude: - - '^docs:' - - '^test:' + - '^docs' + - '^test' diff --git a/cmd/docs.go b/cmd/docs.go index 1e1b525..0d72326 100644 --- a/cmd/docs.go +++ b/cmd/docs.go @@ -15,7 +15,10 @@ package cmd import ( + "fmt" "github.com/spf13/cobra" + "github.com/spf13/cobra/doc" + // "github.com/spf13/cobra/doc" "os" ) @@ -25,26 +28,26 @@ func init() { } var docsCmd = &cobra.Command{ - Use: "docs", - ArgAliases: []string{"doc"}, - Short: "Completion and documentation generators.", + Use: "docs", + ArgAliases: []string{"doc"}, + Short: "Completion and documentation generators.", } -// -// var _ = addCommand(docsCmd, &cobra.Command{ -// Use: "markdown [dir]", -// Short: "Output documentation in markdown. Output dir defaults to ./docs", -// RunE: func(cmd *cobra.Command, args []string) error{ -// dir := "./docs" -// if len(args) > 0 { -// dir = args[0] -// } -// err := doc.GenMarkdownTree(rootCmd, dir) -// if err != nil { -// fmt.Printf("Output to %q.\n", dir) -// } -// return err -// }, -// }) + +var _ = addCommand(docsCmd, &cobra.Command{ + Use: "markdown [dir]", + Short: "Output documentation in markdown. Output dir defaults to ./docs", + RunE: func(cmd *cobra.Command, args []string) error { + dir := "./docs" + if len(args) > 0 { + dir = args[0] + } + err := doc.GenMarkdownTree(rootCmd, dir) + if err != nil { + fmt.Printf("Output to %q.\n", dir) + } + return err + }, +}) var _ = addCommand(docsCmd, &cobra.Command{ Use: "bash", diff --git a/docs/bosun.md b/docs/bosun.md index 28a11e3..fd6fd82 100644 --- a/docs/bosun.md +++ b/docs/bosun.md @@ -10,20 +10,22 @@ building, deploying, or monitoring apps you may want to add them to this tool. ### Options ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. -h, --help help for bosun + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` ### SEE ALSO * [bosun app](bosun_app.md) - App commands -* [bosun config](bosun_config.md) - Root command for configuring bosun. * [bosun docker](bosun_docker.md) - Group of docker-related commands. * [bosun docs](bosun_docs.md) - Completion and documentation generators. +* [bosun e2e](bosun_e2e.md) - Contains sub-commands for running E2E tests. +* [bosun edit](bosun_edit.md) - Edits your root config, or the config of an app if provided. * [bosun env](bosun_env.md) - Sets the environment, and outputs a script which will set environment variables in the environment. Should be called using $() so that the shell will apply the script. * [bosun git](bosun_git.md) - Git commands. * [bosun graylog](bosun_graylog.md) - Group of graylog-related commands. @@ -31,9 +33,16 @@ building, deploying, or monitoring apps you may want to add them to this tool. * [bosun helmsman](bosun_helmsman.md) - Deploys a helmsman to a cluster. Supports --dry-run flag. * [bosun kube](bosun_kube.md) - Group of commands wrapping kubectl. * [bosun lpass](bosun_lpass.md) - Root command for LastPass commands. +* [bosun meta](bosun_meta.md) - Commands for managing bosun itself. * [bosun minikube](bosun_minikube.md) - Group of commands wrapping kubectl. -* [bosun release](bosun_release.md) - Release commands. +* [bosun mongo](bosun_mongo.md) - Commands for working with MongoDB. +* [bosun platform](bosun_platform.md) - Contains platform related sub-commands. +* [bosun release](bosun_release.md) - Contains sub-commands for releases. +* [bosun repo](bosun_repo.md) - Contains sub-commands for interacting with repos. Has some overlap with the git sub-command. * [bosun script](bosun_script.md) - Run a scripted sequence of commands. +* [bosun tools](bosun_tools.md) - Commands for listing and installing tools. +* [bosun upgrade](bosun_upgrade.md) - Upgrades bosun if a newer release is available * [bosun vault](bosun_vault.md) - Updates VaultClient using layout files. Supports --dry-run flag. +* [bosun workspace](bosun_workspace.md) - Workspace commands configure and manipulate the bindings between app repos and your local machine. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app.md b/docs/bosun_app.md index 645f2c1..ae5eca9 100644 --- a/docs/bosun_app.md +++ b/docs/bosun_app.md @@ -9,18 +9,21 @@ App commands ### Options ``` - -a, --all Apply to all known microservices. - -h, --help help for app - -i, --labels strings Apply to microservices with the provided labels. + -a, --all Apply to all known microservices. + --exclude strings Don't include apps which match the provided selectors.". + -h, --help help for app + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. ``` ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -28,16 +31,26 @@ App commands * [bosun](bosun.md) - Devops tool. * [bosun app accept-actual](bosun_app_accept-actual.md) - Updates the desired state to match the actual state of the apps. +* [bosun app action](bosun_app_action.md) - Run an action associated with an app. +* [bosun app add-hosts](bosun_app_add-hosts.md) - Writes out what the hosts file apps to the hosts file would look like if the requested apps were bound to the minikube IP. +* [bosun app build-image](bosun_app_build-image.md) - Builds the image(s) for an app. +* [bosun app bump](bosun_app_bump.md) - Updates the version of an app. * [bosun app bump](bosun_app_bump.md) - Updates the version of an app. * [bosun app clone](bosun_app_clone.md) - Clones the repo for the named app(s). * [bosun app delete](bosun_app_delete.md) - Deletes the specified apps. * [bosun app deploy](bosun_app_deploy.md) - Deploys the requested app. -* [bosun app list](bosun_app_list.md) - Lists apps +* [bosun app import](bosun_app_import.md) - Includes the file in the user's bosun.yaml. If file is not provided, searches for a bosun.yaml file in this or a parent directory. +* [bosun app list](bosun_app_list.md) - Lists the static config of all known apps. * [bosun app publish-chart](bosun_app_publish-chart.md) - Publishes the chart for an app. +* [bosun app publish-image](bosun_app_publish-image.md) - Publishes the image for an app. * [bosun app pull](bosun_app_pull.md) - Pulls the repo for the app. +* [bosun app recycle](bosun_app_recycle.md) - Recycles the requested app(s) by deleting their pods. +* [bosun app remove-hosts](bosun_app_remove-hosts.md) - Removes apps with the current domain from the hosts file. +* [bosun app repo-path](bosun_app_repo-path.md) - Outputs the path where the app is cloned on the local system. * [bosun app run](bosun_app_run.md) - Configures an app to have traffic routed to localhost, then runs the apps's run command. -* [bosun app show](bosun_app_show.md) - Lists the static config of all known apps. +* [bosun app script](bosun_app_script.md) - Run a scripted sequence of commands. +* [bosun app status](bosun_app_status.md) - Lists apps * [bosun app toggle](bosun_app_toggle.md) - Toggles or sets where traffic for an app will be routed to. * [bosun app version](bosun_app_version.md) - Outputs the version of an app. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_accept-actual.md b/docs/bosun_app_accept-actual.md index 1132e92..ada56d8 100644 --- a/docs/bosun_app_accept-actual.md +++ b/docs/bosun_app_accept-actual.md @@ -20,11 +20,14 @@ bosun app accept-actual [name...] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +35,4 @@ bosun app accept-actual [name...] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_action.md b/docs/bosun_app_action.md new file mode 100644 index 0000000..13bf82b --- /dev/null +++ b/docs/bosun_app_action.md @@ -0,0 +1,38 @@ +## bosun app action + +Run an action associated with an app. + +### Synopsis + +If app is not provided, the current directory is used. + +``` +bosun app action [app] {name} [flags] +``` + +### Options + +``` + -h, --help help for action +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_add-hosts.md b/docs/bosun_app_add-hosts.md new file mode 100644 index 0000000..cd47f02 --- /dev/null +++ b/docs/bosun_app_add-hosts.md @@ -0,0 +1,46 @@ +## bosun app add-hosts + +Writes out what the hosts file apps to the hosts file would look like if the requested apps were bound to the minikube IP. + +### Synopsis + +Writes out what the hosts file apps to the hosts file would look like if the requested apps were bound to the minikube IP. + +The current domain and the minikube IP are used to populate the output. To update the hosts file, pipe to sudo tee /etc/hosts. + +``` +bosun app add-hosts [name...] [flags] +``` + +### Examples + +``` +bosun apps add-hosts --all | sudo tee /etc/hosts +``` + +### Options + +``` + -h, --help help for add-hosts +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_build-image.md b/docs/bosun_app_build-image.md new file mode 100644 index 0000000..aedff52 --- /dev/null +++ b/docs/bosun_app_build-image.md @@ -0,0 +1,38 @@ +## bosun app build-image + +Builds the image(s) for an app. + +### Synopsis + +If app is not provided, the current directory is used. The image(s) will be built with the "latest" tag. + +``` +bosun app build-image [app] [flags] +``` + +### Options + +``` + -h, --help help for build-image +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_bump.md b/docs/bosun_app_bump.md index d3ef8f6..a01ae0f 100644 --- a/docs/bosun_app_bump.md +++ b/docs/bosun_app_bump.md @@ -14,17 +14,21 @@ bosun app bump {name} {major|minor|patch|major.minor.patch} [flags] ``` -h, --help help for bump + --tag Create and push a git tag for the version. ``` ### Options inherited from parent commands ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +36,4 @@ bosun app bump {name} {major|minor|patch|major.minor.patch} [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_clone.md b/docs/bosun_app_clone.md index acf8fd8..7b16e24 100644 --- a/docs/bosun_app_clone.md +++ b/docs/bosun_app_clone.md @@ -21,11 +21,14 @@ bosun app clone [name] [name...] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -33,4 +36,4 @@ bosun app clone [name] [name...] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_delete.md b/docs/bosun_app_delete.md index d6bbf6f..aa47d23 100644 --- a/docs/bosun_app_delete.md +++ b/docs/bosun_app_delete.md @@ -21,11 +21,14 @@ bosun app delete [name] [name...] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -33,4 +36,4 @@ bosun app delete [name] [name...] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_deploy.md b/docs/bosun_app_deploy.md index 9563c23..960f9c9 100644 --- a/docs/bosun_app_deploy.md +++ b/docs/bosun_app_deploy.md @@ -13,20 +13,24 @@ bosun app deploy [name] [name...] [flags] ### Options ``` - --deploy-deps Also deploy all dependencies of the requested apps. - -h, --help help for deploy - --set strings Additional values to pass to helm for this deploy. + --deploy-deps Also deploy all dependencies of the requested apps. + -h, --help help for deploy + -s, --set strings Value overrides to set in this deploy, as key=value pairs. + -v, --value-sets strings Additional value sets to include in this deploy. ``` ### Options inherited from parent commands ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -34,4 +38,4 @@ bosun app deploy [name] [name...] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_import.md b/docs/bosun_app_import.md new file mode 100644 index 0000000..b6b0e00 --- /dev/null +++ b/docs/bosun_app_import.md @@ -0,0 +1,38 @@ +## bosun app import + +Includes the file in the user's bosun.yaml. If file is not provided, searches for a bosun.yaml file in this or a parent directory. + +### Synopsis + +Includes the file in the user's bosun.yaml. If file is not provided, searches for a bosun.yaml file in this or a parent directory. + +``` +bosun app import [file] [flags] +``` + +### Options + +``` + -h, --help help for import +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_list.md b/docs/bosun_app_list.md index aef3b9d..7e0befd 100644 --- a/docs/bosun_app_list.md +++ b/docs/bosun_app_list.md @@ -1,37 +1,39 @@ ## bosun app list -Lists apps +Lists the static config of all known apps. ### Synopsis -Lists apps +Lists the static config of all known apps. ``` -bosun app list [name...] [flags] +bosun app list [flags] ``` ### Options ``` - --diff Run diff on deployed charts. - -h, --help help for list - -s, --skip-actual Skip collection of actual state. + -h, --help help for list ``` ### Options inherited from parent commands ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` ### SEE ALSO * [bosun app](bosun_app.md) - App commands +* [bosun app list actions](bosun_app_list_actions.md) - Lists the actions for an app. If no app is provided, lists all actions. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_list_actions.md b/docs/bosun_app_list_actions.md new file mode 100644 index 0000000..d8b647d --- /dev/null +++ b/docs/bosun_app_list_actions.md @@ -0,0 +1,38 @@ +## bosun app list actions + +Lists the actions for an app. If no app is provided, lists all actions. + +### Synopsis + +Lists the actions for an app. If no app is provided, lists all actions. + +``` +bosun app list actions [app] [flags] +``` + +### Options + +``` + -h, --help help for actions +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app list](bosun_app_list.md) - Lists the static config of all known apps. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_publish-chart.md b/docs/bosun_app_publish-chart.md index 359bc29..9744e62 100644 --- a/docs/bosun_app_publish-chart.md +++ b/docs/bosun_app_publish-chart.md @@ -20,11 +20,14 @@ bosun app publish-chart [app] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +35,4 @@ bosun app publish-chart [app] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_publish-image.md b/docs/bosun_app_publish-image.md new file mode 100644 index 0000000..df9727d --- /dev/null +++ b/docs/bosun_app_publish-image.md @@ -0,0 +1,42 @@ +## bosun app publish-image + +Publishes the image for an app. + +### Synopsis + +If app is not provided, the current directory is used. +The image will be published with the "latest" tag and with a tag for the current version. +If the current branch is a release branch, the image will also be published with a tag formatted +as "version-release". + + +``` +bosun app publish-image [app] [flags] +``` + +### Options + +``` + -h, --help help for publish-image +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_pull.md b/docs/bosun_app_pull.md index 549164b..9fbd03f 100644 --- a/docs/bosun_app_pull.md +++ b/docs/bosun_app_pull.md @@ -7,7 +7,7 @@ Pulls the repo for the app. If app is not provided, the current directory is used. ``` -bosun app pull [app] [flags] +bosun app pull [app] [app...] [flags] ``` ### Options @@ -20,11 +20,14 @@ bosun app pull [app] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +35,4 @@ bosun app pull [app] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_recycle.md b/docs/bosun_app_recycle.md new file mode 100644 index 0000000..a2b9ee8 --- /dev/null +++ b/docs/bosun_app_recycle.md @@ -0,0 +1,39 @@ +## bosun app recycle + +Recycles the requested app(s) by deleting their pods. + +### Synopsis + +If app is not specified, the first app in the nearest bosun.yaml file is used. + +``` +bosun app recycle [name] [name...] [flags] +``` + +### Options + +``` + -h, --help help for recycle + --pull-latest Pull the latest image before recycling (only works in minikube). +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_remove-hosts.md b/docs/bosun_app_remove-hosts.md new file mode 100644 index 0000000..73d74ab --- /dev/null +++ b/docs/bosun_app_remove-hosts.md @@ -0,0 +1,38 @@ +## bosun app remove-hosts + +Removes apps with the current domain from the hosts file. + +### Synopsis + +Removes apps with the current domain from the hosts file. + +``` +bosun app remove-hosts [name...] [flags] +``` + +### Options + +``` + -h, --help help for remove-hosts +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_repo-path.md b/docs/bosun_app_repo-path.md new file mode 100644 index 0000000..00a7986 --- /dev/null +++ b/docs/bosun_app_repo-path.md @@ -0,0 +1,38 @@ +## bosun app repo-path + +Outputs the path where the app is cloned on the local system. + +### Synopsis + +Outputs the path where the app is cloned on the local system. + +``` +bosun app repo-path [name] [flags] +``` + +### Options + +``` + -h, --help help for repo-path +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_run.md b/docs/bosun_app_run.md index 8852362..9708f83 100644 --- a/docs/bosun_app_run.md +++ b/docs/bosun_app_run.md @@ -20,11 +20,14 @@ bosun app run [app] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +35,4 @@ bosun app run [app] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_script.md b/docs/bosun_app_script.md new file mode 100644 index 0000000..e4473c6 --- /dev/null +++ b/docs/bosun_app_script.md @@ -0,0 +1,39 @@ +## bosun app script + +Run a scripted sequence of commands. + +### Synopsis + +If app is not provided, the current directory is used. + +``` +bosun app script [app] {name} [flags] +``` + +### Options + +``` + -h, --help help for script + --steps ints Steps to run (defaults to all steps) +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_status.md b/docs/bosun_app_status.md new file mode 100644 index 0000000..e8b9021 --- /dev/null +++ b/docs/bosun_app_status.md @@ -0,0 +1,40 @@ +## bosun app status + +Lists apps + +### Synopsis + +Lists apps + +``` +bosun app status [name...] [flags] +``` + +### Options + +``` + --diff Run diff on deployed charts. + -h, --help help for status + -s, --skip-actual Skip collection of actual state. +``` + +### Options inherited from parent commands + +``` + -a, --all Apply to all known microservices. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". + --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". + -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun app](bosun_app.md) - App commands + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_toggle.md b/docs/bosun_app_toggle.md index 5d706f2..dafa692 100644 --- a/docs/bosun_app_toggle.md +++ b/docs/bosun_app_toggle.md @@ -22,11 +22,14 @@ bosun app toggle [name] [name...] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -34,4 +37,4 @@ bosun app toggle [name] [name...] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_app_version.md b/docs/bosun_app_version.md index b7ba352..85e4603 100644 --- a/docs/bosun_app_version.md +++ b/docs/bosun_app_version.md @@ -20,11 +20,14 @@ bosun app version [name] [flags] ``` -a, --all Apply to all known microservices. - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --exclude strings Don't include apps which match the provided selectors.". --force Force the requested command to be executed even if heuristics indicate it should not be. + --include strings Only include apps which match the provided selectors. --include trumps --exclude.". -i, --labels strings Apply to microservices with the provided labels. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +35,4 @@ bosun app version [name] [flags] * [bosun app](bosun_app.md) - App commands -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_docker.md b/docs/bosun_docker.md index 9abf48b..9e6a9c6 100644 --- a/docs/bosun_docker.md +++ b/docs/bosun_docker.md @@ -15,10 +15,11 @@ Group of docker-related commands. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -28,4 +29,4 @@ Group of docker-related commands. * [bosun docker choose-release-image](bosun_docker_choose-release-image.md) - Tags an image for release. * [bosun docker map-images](bosun_docker_map-images.md) - Retags a list of images -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_docker_choose-release-image.md b/docs/bosun_docker_choose-release-image.md index ef94341..8a13d62 100644 --- a/docs/bosun_docker_choose-release-image.md +++ b/docs/bosun_docker_choose-release-image.md @@ -20,10 +20,11 @@ bosun docker choose-release-image {service-name}:{version-tag} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -31,4 +32,4 @@ bosun docker choose-release-image {service-name}:{version-tag} [flags] * [bosun docker](bosun_docker.md) - Group of docker-related commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_docker_map-images.md b/docs/bosun_docker_map-images.md index 35fe053..0715224 100644 --- a/docs/bosun_docker_map-images.md +++ b/docs/bosun_docker_map-images.md @@ -23,10 +23,11 @@ bosun docker map-images {map file} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -34,4 +35,4 @@ bosun docker map-images {map file} [flags] * [bosun docker](bosun_docker.md) - Group of docker-related commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_docs.md b/docs/bosun_docs.md index b62d0dc..a00b686 100644 --- a/docs/bosun_docs.md +++ b/docs/bosun_docs.md @@ -15,10 +15,11 @@ Completion and documentation generators. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -29,4 +30,4 @@ Completion and documentation generators. * [bosun docs bash](bosun_docs_bash.md) - Completion generator for bash. * [bosun docs markdown](bosun_docs_markdown.md) - Output documentation in markdown. Output dir defaults to ./docs -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_docs_bash.md b/docs/bosun_docs_bash.md index eb2a4e3..75b03b0 100644 --- a/docs/bosun_docs_bash.md +++ b/docs/bosun_docs_bash.md @@ -19,10 +19,11 @@ bosun docs bash [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun docs bash [flags] * [bosun docs](bosun_docs.md) - Completion and documentation generators. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_docs_markdown.md b/docs/bosun_docs_markdown.md index 3d16d2f..e890b10 100644 --- a/docs/bosun_docs_markdown.md +++ b/docs/bosun_docs_markdown.md @@ -19,10 +19,11 @@ bosun docs markdown [dir] [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun docs markdown [dir] [flags] * [bosun docs](bosun_docs.md) - Completion and documentation generators. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_e2e.md b/docs/bosun_e2e.md new file mode 100644 index 0000000..ebc6e49 --- /dev/null +++ b/docs/bosun_e2e.md @@ -0,0 +1,32 @@ +## bosun e2e + +Contains sub-commands for running E2E tests. + +### Synopsis + +Contains sub-commands for running E2E tests. + +### Options + +``` + -h, --help help for e2e +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. +* [bosun e2e list](bosun_e2e_list.md) - Lists E2E test suites. +* [bosun e2e run](bosun_e2e_run.md) - Runs an E2E test suite. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_e2e_list.md b/docs/bosun_e2e_list.md new file mode 100644 index 0000000..2514f6b --- /dev/null +++ b/docs/bosun_e2e_list.md @@ -0,0 +1,34 @@ +## bosun e2e list + +Lists E2E test suites. + +### Synopsis + +Lists E2E test suites. + +``` +bosun e2e list [flags] +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun e2e](bosun_e2e.md) - Contains sub-commands for running E2E tests. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_e2e_run.md b/docs/bosun_e2e_run.md new file mode 100644 index 0000000..96e448a --- /dev/null +++ b/docs/bosun_e2e_run.md @@ -0,0 +1,37 @@ +## bosun e2e run + +Runs an E2E test suite. + +### Synopsis + +Runs an E2E test suite. + +``` +bosun e2e run {suite} [flags] +``` + +### Options + +``` + -h, --help help for run + --skip-setup Skip setup scripts. + --skip-teardown Skip teardown scripts. + --tests strings Specific tests to run. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun e2e](bosun_e2e.md) - Contains sub-commands for running E2E tests. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_edit.md b/docs/bosun_edit.md new file mode 100644 index 0000000..1ae2e1d --- /dev/null +++ b/docs/bosun_edit.md @@ -0,0 +1,34 @@ +## bosun edit + +Edits your root config, or the config of an app if provided. + +### Synopsis + +Edits your root config, or the config of an app if provided. + +``` +bosun edit [app] [flags] +``` + +### Options + +``` + -h, --help help for edit +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_env.md b/docs/bosun_env.md index ed9503f..3c0b871 100644 --- a/docs/bosun_env.md +++ b/docs/bosun_env.md @@ -4,10 +4,10 @@ Sets the environment, and outputs a script which will set environment variables ### Synopsis -Sets the environment, and outputs a script which will set environment variables in the environment. Should be called using $() so that the shell will apply the script. +The special environment name `current` will emit the script for the current environment without changing anything. ``` -bosun env {environment} [flags] +bosun env [environment] [flags] ``` ### Examples @@ -19,22 +19,28 @@ $(bosun env {env}) ### Options ``` - -h, --help help for env + --current Write script for setting current environment. + -h, --help help for env ``` ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` ### SEE ALSO * [bosun](bosun.md) - Devops tool. +* [bosun env get-cert](bosun_env_get-cert.md) - Creates or reads a certificate for the specified hosts. +* [bosun env list](bosun_env_list.md) - Lists environments. * [bosun env name](bosun_env_name.md) - Prints the name of the current environment. +* [bosun env show](bosun_env_show.md) - Shows the current environment with its valueSets. +* [bosun env value-sets](bosun_env_value-sets.md) - Lists known value-sets. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_env_get-cert.md b/docs/bosun_env_get-cert.md new file mode 100644 index 0000000..0387e19 --- /dev/null +++ b/docs/bosun_env_get-cert.md @@ -0,0 +1,34 @@ +## bosun env get-cert + +Creates or reads a certificate for the specified hosts. + +### Synopsis + +Requires mkcert to be installed. + +``` +bosun env get-cert {name} {part=cert|key} {hosts...} [flags] +``` + +### Options + +``` + -h, --help help for get-cert +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun env](bosun_env.md) - Sets the environment, and outputs a script which will set environment variables in the environment. Should be called using $() so that the shell will apply the script. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_env_list.md b/docs/bosun_env_list.md new file mode 100644 index 0000000..a7b36a6 --- /dev/null +++ b/docs/bosun_env_list.md @@ -0,0 +1,34 @@ +## bosun env list + +Lists environments. + +### Synopsis + +Lists environments. + +``` +bosun env list [flags] +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun env](bosun_env.md) - Sets the environment, and outputs a script which will set environment variables in the environment. Should be called using $() so that the shell will apply the script. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_env_name.md b/docs/bosun_env_name.md index 6f6f2b5..e6628ce 100644 --- a/docs/bosun_env_name.md +++ b/docs/bosun_env_name.md @@ -19,10 +19,11 @@ bosun env name [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun env name [flags] * [bosun env](bosun_env.md) - Sets the environment, and outputs a script which will set environment variables in the environment. Should be called using $() so that the shell will apply the script. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_env_show.md b/docs/bosun_env_show.md new file mode 100644 index 0000000..cea8b00 --- /dev/null +++ b/docs/bosun_env_show.md @@ -0,0 +1,34 @@ +## bosun env show + +Shows the current environment with its valueSets. + +### Synopsis + +Shows the current environment with its valueSets. + +``` +bosun env show [name] [flags] +``` + +### Options + +``` + -h, --help help for show +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun env](bosun_env.md) - Sets the environment, and outputs a script which will set environment variables in the environment. Should be called using $() so that the shell will apply the script. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_env_value-sets.md b/docs/bosun_env_value-sets.md new file mode 100644 index 0000000..2526be9 --- /dev/null +++ b/docs/bosun_env_value-sets.md @@ -0,0 +1,34 @@ +## bosun env value-sets + +Lists known value-sets. + +### Synopsis + +Lists known value-sets. + +``` +bosun env value-sets [flags] +``` + +### Options + +``` + -h, --help help for value-sets +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun env](bosun_env.md) - Sets the environment, and outputs a script which will set environment variables in the environment. Should be called using $() so that the shell will apply the script. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git.md b/docs/bosun_git.md index 4fe76ef..8bc5431 100644 --- a/docs/bosun_git.md +++ b/docs/bosun_git.md @@ -15,17 +15,21 @@ Git commands. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` ### SEE ALSO * [bosun](bosun.md) - Devops tool. +* [bosun git accept-pull-request](bosun_git_accept-pull-request.md) - Accepts a pull request and merges it into master, optionally bumping the version and tagging the master branch. * [bosun git deploy](bosun_git_deploy.md) - Deploy-related commands. -* [bosun git task](bosun_git_task.md) - Creates a task in the current repo for the story, and a branch for that task. +* [bosun git pull-request](bosun_git_pull-request.md) - Opens a pull request. +* [bosun git task](bosun_git_task.md) - Creates a task in the current repo, and a branch for that task. Optionally attaches task to a story, if flags are set. +* [bosun git token](bosun_git_token.md) - Prints the github token. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git_accept-pull-request.md b/docs/bosun_git_accept-pull-request.md new file mode 100644 index 0000000..10fe115 --- /dev/null +++ b/docs/bosun_git_accept-pull-request.md @@ -0,0 +1,35 @@ +## bosun git accept-pull-request + +Accepts a pull request and merges it into master, optionally bumping the version and tagging the master branch. + +### Synopsis + +Accepts a pull request and merges it into master, optionally bumping the version and tagging the master branch. + +``` +bosun git accept-pull-request [number] [major|minor|patch|major.minor.patch] [flags] +``` + +### Options + +``` + --app strings Apps to apply version bump to. + -h, --help help for accept-pull-request +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun git](bosun_git.md) - Git commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git_deploy.md b/docs/bosun_git_deploy.md index 85fd897..0238794 100644 --- a/docs/bosun_git_deploy.md +++ b/docs/bosun_git_deploy.md @@ -15,10 +15,11 @@ Deploy-related commands. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -28,4 +29,4 @@ Deploy-related commands. * [bosun git deploy start](bosun_git_deploy_start.md) - Notifies github that a deploy has happened. * [bosun git deploy update](bosun_git_deploy_update.md) - Notifies github that a deploy has happened. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git_deploy_start.md b/docs/bosun_git_deploy_start.md index d71d661..98c9e03 100644 --- a/docs/bosun_git_deploy_start.md +++ b/docs/bosun_git_deploy_start.md @@ -19,10 +19,11 @@ bosun git deploy start {cluster} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun git deploy start {cluster} [flags] * [bosun git deploy](bosun_git_deploy.md) - Deploy-related commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git_deploy_update.md b/docs/bosun_git_deploy_update.md index e2cf267..c953e58 100644 --- a/docs/bosun_git_deploy_update.md +++ b/docs/bosun_git_deploy_update.md @@ -19,10 +19,11 @@ bosun git deploy update {deployment-id} {success|failure} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun git deploy update {deployment-id} {success|failure} [flags] * [bosun git deploy](bosun_git_deploy.md) - Deploy-related commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git_pull-request.md b/docs/bosun_git_pull-request.md new file mode 100644 index 0000000..bf98175 --- /dev/null +++ b/docs/bosun_git_pull-request.md @@ -0,0 +1,38 @@ +## bosun git pull-request + +Opens a pull request. + +### Synopsis + +Opens a pull request. + +``` +bosun git pull-request [flags] +``` + +### Options + +``` + --base string Target branch for merge. (default "master") + --body string Body of PR + -h, --help help for pull-request + --reviewer strings Reviewers to request. + --title string Title of PR +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun git](bosun_git.md) - Git commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git_task.md b/docs/bosun_git_task.md index 1944618..70fc0bb 100644 --- a/docs/bosun_git_task.md +++ b/docs/bosun_git_task.md @@ -1,13 +1,13 @@ ## bosun git task -Creates a task in the current repo for the story, and a branch for that task. +Creates a task in the current repo, and a branch for that task. Optionally attaches task to a story, if flags are set. ### Synopsis Requires github hub tool to be installed (https://hub.github.com/). ``` -bosun git task {parent-number} {task name} [flags] +bosun git task {task name} [flags] ``` ### Options @@ -15,17 +15,19 @@ bosun git task {parent-number} {task name} [flags] ``` -m, --body string Issue body. -h, --help help for task - --parent-org string Parent org. (default "naveegoinc") - --parent-repo string Parent repo. (default "stories") + --parent-org string Story org. (default "naveegoinc") + --parent-repo string Story repo. (default "stories") + --story int Number of the story to use as a parent. ``` ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -33,4 +35,4 @@ bosun git task {parent-number} {task name} [flags] * [bosun git](bosun_git.md) - Git commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_git_token.md b/docs/bosun_git_token.md new file mode 100644 index 0000000..a3e966f --- /dev/null +++ b/docs/bosun_git_token.md @@ -0,0 +1,34 @@ +## bosun git token + +Prints the github token. + +### Synopsis + +Prints the github token. + +``` +bosun git token [flags] +``` + +### Options + +``` + -h, --help help for token +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun git](bosun_git.md) - Git commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_graylog.md b/docs/bosun_graylog.md index b45db78..af25422 100644 --- a/docs/bosun_graylog.md +++ b/docs/bosun_graylog.md @@ -15,10 +15,11 @@ Group of graylog-related commands. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -27,4 +28,4 @@ Group of graylog-related commands. * [bosun](bosun.md) - Devops tool. * [bosun graylog configure](bosun_graylog_configure.md) - Configures graylog using API -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_graylog_configure.md b/docs/bosun_graylog_configure.md index a458228..fb23c40 100644 --- a/docs/bosun_graylog_configure.md +++ b/docs/bosun_graylog_configure.md @@ -20,10 +20,11 @@ bosun graylog configure {config-file.yaml} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -31,4 +32,4 @@ bosun graylog configure {config-file.yaml} [flags] * [bosun graylog](bosun_graylog.md) - Group of graylog-related commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_helm.md b/docs/bosun_helm.md index 118cf02..c1d6117 100644 --- a/docs/bosun_helm.md +++ b/docs/bosun_helm.md @@ -15,10 +15,11 @@ If there's a sequence of helm commands that you use a lot, add them as a command ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -28,4 +29,4 @@ If there's a sequence of helm commands that you use a lot, add them as a command * [bosun helm init](bosun_helm_init.md) - Initializes helm/tiller. * [bosun helm publish](bosun_helm_publish.md) - Publishes one or more charts to our helm repo. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_helm_init.md b/docs/bosun_helm_init.md index ed25f7d..722d940 100644 --- a/docs/bosun_helm_init.md +++ b/docs/bosun_helm_init.md @@ -19,10 +19,11 @@ bosun helm init [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun helm init [flags] * [bosun helm](bosun_helm.md) - Wrappers for custom helm commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_helm_publish.md b/docs/bosun_helm_publish.md index efd4bce..7a3fd2f 100644 --- a/docs/bosun_helm_publish.md +++ b/docs/bosun_helm_publish.md @@ -26,10 +26,11 @@ bosun helm publish [chart-paths...] [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -37,4 +38,4 @@ bosun helm publish [chart-paths...] [flags] * [bosun helm](bosun_helm.md) - Wrappers for custom helm commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_helmsman.md b/docs/bosun_helmsman.md index 0c4cc2a..41ed79f 100644 --- a/docs/bosun_helmsman.md +++ b/docs/bosun_helmsman.md @@ -36,10 +36,11 @@ bosun helmsman {helmsman-file} [additional-helmsman-files...} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -47,4 +48,4 @@ bosun helmsman {helmsman-file} [additional-helmsman-files...} [flags] * [bosun](bosun.md) - Devops tool. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_kube.md b/docs/bosun_kube.md index 462d3b4..9b8964c 100644 --- a/docs/bosun_kube.md +++ b/docs/bosun_kube.md @@ -15,17 +15,21 @@ You must have the cluster set in kubectl. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` ### SEE ALSO * [bosun](bosun.md) - Devops tool. +* [bosun kube add-eks](bosun_kube_add-eks.md) - Adds an EKS cluster to your kubeconfig. +* [bosun kube add-namespace](bosun_kube_add-namespace.md) - Adds a namespace to your cluster. +* [bosun kube dashboard](bosun_kube_dashboard.md) - Opens dashboard for current cluster. * [bosun kube dashboard-token](bosun_kube_dashboard-token.md) - Writes out a dashboard UI access token. * [bosun kube pull-secret](bosun_kube_pull-secret.md) - Sets a pull secret in kubernetes for https://docker.n5o.black. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_kube_add-eks.md b/docs/bosun_kube_add-eks.md new file mode 100644 index 0000000..ef4153d --- /dev/null +++ b/docs/bosun_kube_add-eks.md @@ -0,0 +1,34 @@ +## bosun kube add-eks + +Adds an EKS cluster to your kubeconfig. + +### Synopsis + +You must the AWS CLI installed. + +``` +bosun kube add-eks {name} [region] [flags] +``` + +### Options + +``` + -h, --help help for add-eks +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun kube](bosun_kube.md) - Group of commands wrapping kubectl. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_kube_add-namespace.md b/docs/bosun_kube_add-namespace.md new file mode 100644 index 0000000..db18370 --- /dev/null +++ b/docs/bosun_kube_add-namespace.md @@ -0,0 +1,34 @@ +## bosun kube add-namespace + +Adds a namespace to your cluster. + +### Synopsis + +Adds a namespace to your cluster. + +``` +bosun kube add-namespace {name} [flags] +``` + +### Options + +``` + -h, --help help for add-namespace +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun kube](bosun_kube.md) - Group of commands wrapping kubectl. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_kube_dashboard-token.md b/docs/bosun_kube_dashboard-token.md index 1d3721d..8768130 100644 --- a/docs/bosun_kube_dashboard-token.md +++ b/docs/bosun_kube_dashboard-token.md @@ -19,10 +19,11 @@ bosun kube dashboard-token [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun kube dashboard-token [flags] * [bosun kube](bosun_kube.md) - Group of commands wrapping kubectl. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_kube_dashboard.md b/docs/bosun_kube_dashboard.md new file mode 100644 index 0000000..033f229 --- /dev/null +++ b/docs/bosun_kube_dashboard.md @@ -0,0 +1,35 @@ +## bosun kube dashboard + +Opens dashboard for current cluster. + +### Synopsis + +You must have the cluster set in kubectl. + +``` +bosun kube dashboard [flags] +``` + +### Options + +``` + -h, --help help for dashboard + --url Display dashboard URL instead of opening a browser +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun kube](bosun_kube.md) - Group of commands wrapping kubectl. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_kube_pull-secret.md b/docs/bosun_kube_pull-secret.md index 1afc61a..63941fd 100644 --- a/docs/bosun_kube_pull-secret.md +++ b/docs/bosun_kube_pull-secret.md @@ -22,10 +22,11 @@ bosun kube pull-secret [username] [password] [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -33,4 +34,4 @@ bosun kube pull-secret [username] [password] [flags] * [bosun kube](bosun_kube.md) - Group of commands wrapping kubectl. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_lpass.md b/docs/bosun_lpass.md index dc5e6ef..ada953d 100644 --- a/docs/bosun_lpass.md +++ b/docs/bosun_lpass.md @@ -15,10 +15,11 @@ Root command for LastPass commands. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -27,4 +28,4 @@ Root command for LastPass commands. * [bosun](bosun.md) - Devops tool. * [bosun lpass password](bosun_lpass_password.md) - Gets (or generates if not found) a password in LastPass. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_lpass_password.md b/docs/bosun_lpass_password.md index 3fdb369..9ae3c42 100644 --- a/docs/bosun_lpass_password.md +++ b/docs/bosun_lpass_password.md @@ -19,10 +19,11 @@ bosun lpass password {folder/name} {username} {url} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun lpass password {folder/name} {username} {url} [flags] * [bosun lpass](bosun_lpass.md) - Root command for LastPass commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_meta.md b/docs/bosun_meta.md new file mode 100644 index 0000000..8f66dbb --- /dev/null +++ b/docs/bosun_meta.md @@ -0,0 +1,33 @@ +## bosun meta + +Commands for managing bosun itself. + +### Synopsis + +Commands for managing bosun itself. + +### Options + +``` + -h, --help help for meta +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. +* [bosun meta downgrade](bosun_meta_downgrade.md) - Downgrades bosun to a previous release. +* [bosun meta upgrade](bosun_meta_upgrade.md) - Upgrades bosun if a newer release is available +* [bosun meta version](bosun_meta_version.md) - Shows bosun version + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_meta_downgrade.md b/docs/bosun_meta_downgrade.md new file mode 100644 index 0000000..ae323f6 --- /dev/null +++ b/docs/bosun_meta_downgrade.md @@ -0,0 +1,35 @@ +## bosun meta downgrade + +Downgrades bosun to a previous release. + +### Synopsis + +Downgrades bosun to a previous release. + +``` +bosun meta downgrade [flags] +``` + +### Options + +``` + -h, --help help for downgrade + -p, --pre-release Upgrade to pre-release version. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun meta](bosun_meta.md) - Commands for managing bosun itself. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_meta_version.md b/docs/bosun_meta_version.md new file mode 100644 index 0000000..f1330d3 --- /dev/null +++ b/docs/bosun_meta_version.md @@ -0,0 +1,34 @@ +## bosun meta version + +Shows bosun version + +### Synopsis + +Shows bosun version + +``` +bosun meta version [flags] +``` + +### Options + +``` + -h, --help help for version +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun meta](bosun_meta.md) - Commands for managing bosun itself. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_minikube.md b/docs/bosun_minikube.md index d1b38c7..243954c 100644 --- a/docs/bosun_minikube.md +++ b/docs/bosun_minikube.md @@ -15,10 +15,11 @@ You must have the cluster set in kubectl. ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -28,4 +29,4 @@ You must have the cluster set in kubectl. * [bosun minikube forward](bosun_minikube_forward.md) - Forwards ports to the services running on minikube * [bosun minikube up](bosun_minikube_up.md) - Brings up minikube if it's not currently running. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_minikube_forward.md b/docs/bosun_minikube_forward.md index 6d566c9..dbb19a6 100644 --- a/docs/bosun_minikube_forward.md +++ b/docs/bosun_minikube_forward.md @@ -20,10 +20,11 @@ bosun minikube forward [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -31,4 +32,4 @@ bosun minikube forward [flags] * [bosun minikube](bosun_minikube.md) - Group of commands wrapping kubectl. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_minikube_up.md b/docs/bosun_minikube_up.md index 67bb468..dc48ed4 100644 --- a/docs/bosun_minikube_up.md +++ b/docs/bosun_minikube_up.md @@ -13,16 +13,18 @@ bosun minikube up [flags] ### Options ``` - -h, --help help for up + --driver string The driver to use for minikube. (default "virtualbox") + -h, --help help for up ``` ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +32,4 @@ bosun minikube up [flags] * [bosun minikube](bosun_minikube.md) - Group of commands wrapping kubectl. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_mongo.md b/docs/bosun_mongo.md new file mode 100644 index 0000000..98eb5d4 --- /dev/null +++ b/docs/bosun_mongo.md @@ -0,0 +1,31 @@ +## bosun mongo + +Commands for working with MongoDB. + +### Synopsis + +Commands for working with MongoDB. + +### Options + +``` + -h, --help help for mongo +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. +* [bosun mongo import](bosun_mongo_import.md) - Import a Mongo database + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_mongo_import.md b/docs/bosun_mongo_import.md new file mode 100644 index 0000000..d363d42 --- /dev/null +++ b/docs/bosun_mongo_import.md @@ -0,0 +1,51 @@ +## bosun mongo import + +Import a Mongo database + +### Synopsis + +Import a Mongo database + +``` +bosun mongo import [flags] +``` + +### Examples + +``` +mongo import db.yaml +``` + +### Options + +``` + --auth-source string The authSource to use when validating the credentials (default "admin") + -h, --help help for import + --host string The host address for connecting to the MongoDB server. (Default: 127.0.0.1) (default "127.0.0.1") + --kube-port int The port to use for mapping kubectl port-forward to your local host. Only used with --kube-port-forward (default 27017) + --kube-port-forward Tunnels communication to Mongo using the kubectl port-forward + --kube-service-name string Sets the kubernetes service name to use for forwarding. Only used with --kube-port-foward (default "svc/mongodb") + --mongo-database string The name of the database that will updated by this operation. If not set, the name of the file is used without the file extension. + --password string The password to use when connecting to Mongo + --port string The port for connecting to the MongoDB server. (Default: 27017) (default "27017") + --rebuild-db Forces a rebuild of the database by dropping and re-creating all collections + --username string The username to use when connecting to Mongo + --vault-auth string The database credentials path to use with vault. Setting this supersedes using username and password. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun mongo](bosun_mongo.md) - Commands for working with MongoDB. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_platform.md b/docs/bosun_platform.md new file mode 100644 index 0000000..f9a904b --- /dev/null +++ b/docs/bosun_platform.md @@ -0,0 +1,35 @@ +## bosun platform + +Contains platform related sub-commands. + +### Synopsis + +Contains platform related sub-commands. + +### Options + +``` + -h, --help help for platform +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. +* [bosun platform include](bosun_platform_include.md) - Adds an app from the workspace to the platform. +* [bosun platform list](bosun_platform_list.md) - Lists platforms. +* [bosun platform pull](bosun_platform_pull.md) - Pulls the latest code, and updates the `latest` release. +* [bosun platform show](bosun_platform_show.md) - Shows the named platform, or the current platform if no name provided. +* [bosun platform use](bosun_platform_use.md) - Sets the platform. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_platform_include.md b/docs/bosun_platform_include.md new file mode 100644 index 0000000..be918c7 --- /dev/null +++ b/docs/bosun_platform_include.md @@ -0,0 +1,38 @@ +## bosun platform include + +Adds an app from the workspace to the platform. + +### Synopsis + +Adds an app from the workspace to the platform. + +``` +bosun platform include [appNames...] [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for include + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun platform](bosun_platform.md) - Contains platform related sub-commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_platform_list.md b/docs/bosun_platform_list.md new file mode 100644 index 0000000..a195855 --- /dev/null +++ b/docs/bosun_platform_list.md @@ -0,0 +1,34 @@ +## bosun platform list + +Lists platforms. + +### Synopsis + +Lists platforms. + +``` +bosun platform list [flags] +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun platform](bosun_platform.md) - Contains platform related sub-commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_platform_pull.md b/docs/bosun_platform_pull.md new file mode 100644 index 0000000..b9bdd10 --- /dev/null +++ b/docs/bosun_platform_pull.md @@ -0,0 +1,38 @@ +## bosun platform pull + +Pulls the latest code, and updates the `latest` release. + +### Synopsis + +Pulls the latest code, and updates the `latest` release. + +``` +bosun platform pull [names...] [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for pull + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun platform](bosun_platform.md) - Contains platform related sub-commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_platform_show.md b/docs/bosun_platform_show.md new file mode 100644 index 0000000..2966aad --- /dev/null +++ b/docs/bosun_platform_show.md @@ -0,0 +1,34 @@ +## bosun platform show + +Shows the named platform, or the current platform if no name provided. + +### Synopsis + +Shows the named platform, or the current platform if no name provided. + +``` +bosun platform show [name] [flags] +``` + +### Options + +``` + -h, --help help for show +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun platform](bosun_platform.md) - Contains platform related sub-commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_platform_use.md b/docs/bosun_platform_use.md new file mode 100644 index 0000000..c4baaf3 --- /dev/null +++ b/docs/bosun_platform_use.md @@ -0,0 +1,34 @@ +## bosun platform use + +Sets the platform. + +### Synopsis + +Sets the platform. + +``` +bosun platform use [name] [flags] +``` + +### Options + +``` + -h, --help help for use +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun platform](bosun_platform.md) - Contains platform related sub-commands. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release.md b/docs/bosun_release.md index 525f65d..9fca00f 100644 --- a/docs/bosun_release.md +++ b/docs/bosun_release.md @@ -1,36 +1,45 @@ ## bosun release -Release commands. +Contains sub-commands for releases. ### Synopsis -Release commands. +Contains sub-commands for releases. ### Options ``` - -h, --help help for release + -h, --help help for release + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). ``` ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` ### SEE ALSO * [bosun](bosun.md) - Devops tool. -* [bosun release add](bosun_release_add.md) - Adds one or more apps to a release. -* [bosun release create](bosun_release_create.md) - Creates a new release. +* [bosun release delete](bosun_release_delete.md) - Deletes a release. * [bosun release deploy](bosun_release_deploy.md) - Deploys the release. +* [bosun release diff](bosun_release_diff.md) - Reports the differences between the values for an app in two scenarios. +* [bosun release dot](bosun_release_dot.md) - Prints a dot diagram of the release. +* [bosun release impact](bosun_release_impact.md) - Reports on the changes deploying the release will inflict on the current environment. * [bosun release list](bosun_release_list.md) - Lists known releases. -* [bosun release show](bosun_release_show.md) - Lists known releases. +* [bosun release merge](bosun_release_merge.md) - Merges the release branch back to master for each app in the release (or the listed apps) +* [bosun release plan](bosun_release_plan.md) - Contains sub-commands for release planning. +* [bosun release replan](bosun_release_replan.md) - Returns the release to the planning stage. +* [bosun release show](bosun_release_show.md) - Lists the apps in the current release. +* [bosun release show-values](bosun_release_show-values.md) - Shows the values which will be used for a release. +* [bosun release test](bosun_release_test.md) - Runs the tests for the apps in the release. * [bosun release use](bosun_release_use.md) - Sets the release which release commands will work against. * [bosun release validate](bosun_release_validate.md) - Validates the release. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_delete.md b/docs/bosun_release_delete.md new file mode 100644 index 0000000..c66e2b4 --- /dev/null +++ b/docs/bosun_release_delete.md @@ -0,0 +1,35 @@ +## bosun release delete + +Deletes a release. + +### Synopsis + +Deletes a release. + +``` +bosun release delete [name] [flags] +``` + +### Options + +``` + -h, --help help for delete +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_deploy.md b/docs/bosun_release_deploy.md index a5209c1..4eff7b6 100644 --- a/docs/bosun_release_deploy.md +++ b/docs/bosun_release_deploy.md @@ -13,21 +13,30 @@ bosun release deploy [flags] ### Options ``` - -h, --help help for deploy + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for deploy + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. + -s, --set strings Value overrides to set in this deploy, as path.to.key=value pairs. + --skip-validation Skips running validation before deploying the release. + -v, --value-sets strings Additional value sets to include in this deploy. ``` ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") - --dry-run Display rendered plans, but do not actually execute (not supported by all commands). - --force Force the requested command to be executed even if heuristics indicate it should not be. - --verbose Enable verbose logging. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. ``` ### SEE ALSO -* [bosun release](bosun_release.md) - Release commands. +* [bosun release](bosun_release.md) - Contains sub-commands for releases. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_diff.md b/docs/bosun_release_diff.md new file mode 100644 index 0000000..4d364f6 --- /dev/null +++ b/docs/bosun_release_diff.md @@ -0,0 +1,46 @@ +## bosun release diff + +Reports the differences between the values for an app in two scenarios. + +### Synopsis + +If the release part of the scenario is not provided, a transient release will be created and used instead. + +``` +bosun release diff {app} [release/]{env} [release]/{env} [flags] +``` + +### Examples + +``` +This command will show the differences between the values deployed +to the blue environment in release 2.4.2 and the current values for the +green environment: + +diff go-between 2.4.2/blue green + +``` + +### Options + +``` + -h, --help help for diff +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_dot.md b/docs/bosun_release_dot.md new file mode 100644 index 0000000..05a2492 --- /dev/null +++ b/docs/bosun_release_dot.md @@ -0,0 +1,35 @@ +## bosun release dot + +Prints a dot diagram of the release. + +### Synopsis + +Prints a dot diagram of the release. + +``` +bosun release dot [flags] +``` + +### Options + +``` + -h, --help help for dot +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_impact.md b/docs/bosun_release_impact.md new file mode 100644 index 0000000..0734a43 --- /dev/null +++ b/docs/bosun_release_impact.md @@ -0,0 +1,39 @@ +## bosun release impact + +Reports on the changes deploying the release will inflict on the current environment. + +### Synopsis + +Reports on the changes deploying the release will inflict on the current environment. + +``` +bosun release impact [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for impact + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_list.md b/docs/bosun_release_list.md index a7fc83e..00982e5 100644 --- a/docs/bosun_release_list.md +++ b/docs/bosun_release_list.md @@ -19,15 +19,17 @@ bosun release list [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") - --dry-run Display rendered plans, but do not actually execute (not supported by all commands). - --force Force the requested command to be executed even if heuristics indicate it should not be. - --verbose Enable verbose logging. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. ``` ### SEE ALSO -* [bosun release](bosun_release.md) - Release commands. +* [bosun release](bosun_release.md) - Contains sub-commands for releases. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_merge.md b/docs/bosun_release_merge.md new file mode 100644 index 0000000..55775c9 --- /dev/null +++ b/docs/bosun_release_merge.md @@ -0,0 +1,39 @@ +## bosun release merge + +Merges the release branch back to master for each app in the release (or the listed apps) + +### Synopsis + +Merges the release branch back to master for each app in the release (or the listed apps) + +``` +bosun release merge [apps...] [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for merge + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_plan.md b/docs/bosun_release_plan.md new file mode 100644 index 0000000..406748a --- /dev/null +++ b/docs/bosun_release_plan.md @@ -0,0 +1,41 @@ +## bosun release plan + +Contains sub-commands for release planning. + +### Synopsis + +Contains sub-commands for release planning. + +``` +bosun release plan [flags] +``` + +### Options + +``` + -h, --help help for plan +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. +* [bosun release plan app](bosun_release_plan_app.md) - Sets the disposition of an app in the release. +* [bosun release plan commit](bosun_release_plan_commit.md) - Commit the current release plan. +* [bosun release plan discard](bosun_release_plan_discard.md) - Discard the current release plan. +* [bosun release plan edit](bosun_release_plan_edit.md) - Opens release plan in an editor. +* [bosun release plan show](bosun_release_plan_show.md) - Shows the current release plan. +* [bosun release plan start](bosun_release_plan_start.md) - Begins planning a new release. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_plan_app.md b/docs/bosun_release_plan_app.md new file mode 100644 index 0000000..e5194ab --- /dev/null +++ b/docs/bosun_release_plan_app.md @@ -0,0 +1,42 @@ +## bosun release plan app + +Sets the disposition of an app in the release. + +### Synopsis + +Alternatively, you can edit the plan directly in the platform yaml file. + +``` +bosun release plan app [flags] +``` + +### Options + +``` + --all Will include all items. + --bump string The version bump to apply to upgrades among matched apps. + --deploy Set to deploy matched apps. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for app + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. + --reason string The reason to set for the status change for matched apps. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release plan](bosun_release_plan.md) - Contains sub-commands for release planning. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_plan_commit.md b/docs/bosun_release_plan_commit.md new file mode 100644 index 0000000..e229b5a --- /dev/null +++ b/docs/bosun_release_plan_commit.md @@ -0,0 +1,35 @@ +## bosun release plan commit + +Commit the current release plan. + +### Synopsis + +Commit the current release plan. + +``` +bosun release plan commit [flags] +``` + +### Options + +``` + -h, --help help for commit +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release plan](bosun_release_plan.md) - Contains sub-commands for release planning. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_plan_discard.md b/docs/bosun_release_plan_discard.md new file mode 100644 index 0000000..5c920cd --- /dev/null +++ b/docs/bosun_release_plan_discard.md @@ -0,0 +1,35 @@ +## bosun release plan discard + +Discard the current release plan. + +### Synopsis + +Discard the current release plan. + +``` +bosun release plan discard [flags] +``` + +### Options + +``` + -h, --help help for discard +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release plan](bosun_release_plan.md) - Contains sub-commands for release planning. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_plan_edit.md b/docs/bosun_release_plan_edit.md new file mode 100644 index 0000000..805aa03 --- /dev/null +++ b/docs/bosun_release_plan_edit.md @@ -0,0 +1,35 @@ +## bosun release plan edit + +Opens release plan in an editor. + +### Synopsis + +Opens release plan in an editor. + +``` +bosun release plan edit [flags] +``` + +### Options + +``` + -h, --help help for edit +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release plan](bosun_release_plan.md) - Contains sub-commands for release planning. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_plan_show.md b/docs/bosun_release_plan_show.md new file mode 100644 index 0000000..f0e3b20 --- /dev/null +++ b/docs/bosun_release_plan_show.md @@ -0,0 +1,35 @@ +## bosun release plan show + +Shows the current release plan. + +### Synopsis + +Shows the current release plan. + +``` +bosun release plan show [flags] +``` + +### Options + +``` + -h, --help help for show +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release plan](bosun_release_plan.md) - Contains sub-commands for release planning. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_plan_start.md b/docs/bosun_release_plan_start.md new file mode 100644 index 0000000..370ecd2 --- /dev/null +++ b/docs/bosun_release_plan_start.md @@ -0,0 +1,39 @@ +## bosun release plan start + +Begins planning a new release. + +### Synopsis + +Begins planning a new release. + +``` +bosun release plan start [flags] +``` + +### Options + +``` + --bump string The version bump of the release. + -h, --help help for start + --name string The name of the release (defaults to the version if not provided). + --patch-parent string The release the plan will prefer to create branches from. + --version string The version of the release. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release plan](bosun_release_plan.md) - Contains sub-commands for release planning. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_replan.md b/docs/bosun_release_replan.md new file mode 100644 index 0000000..0a89350 --- /dev/null +++ b/docs/bosun_release_replan.md @@ -0,0 +1,35 @@ +## bosun release replan + +Returns the release to the planning stage. + +### Synopsis + +Returns the release to the planning stage. + +``` +bosun release replan [flags] +``` + +### Options + +``` + -h, --help help for replan +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_show-values.md b/docs/bosun_release_show-values.md new file mode 100644 index 0000000..eff5aad --- /dev/null +++ b/docs/bosun_release_show-values.md @@ -0,0 +1,35 @@ +## bosun release show-values + +Shows the values which will be used for a release. + +### Synopsis + +Shows the values which will be used for a release. + +``` +bosun release show-values {app} [flags] +``` + +### Options + +``` + -h, --help help for show-values +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_show.md b/docs/bosun_release_show.md index b000646..911c492 100644 --- a/docs/bosun_release_show.md +++ b/docs/bosun_release_show.md @@ -1,10 +1,10 @@ ## bosun release show -Lists known releases. +Lists the apps in the current release. ### Synopsis -Lists known releases. +Lists the apps in the current release. ``` bosun release show [flags] @@ -19,15 +19,17 @@ bosun release show [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") - --dry-run Display rendered plans, but do not actually execute (not supported by all commands). - --force Force the requested command to be executed even if heuristics indicate it should not be. - --verbose Enable verbose logging. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. ``` ### SEE ALSO -* [bosun release](bosun_release.md) - Release commands. +* [bosun release](bosun_release.md) - Contains sub-commands for releases. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_test.md b/docs/bosun_release_test.md new file mode 100644 index 0000000..d3d08a0 --- /dev/null +++ b/docs/bosun_release_test.md @@ -0,0 +1,39 @@ +## bosun release test + +Runs the tests for the apps in the release. + +### Synopsis + +Runs the tests for the apps in the release. + +``` +bosun release test [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for test + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun release](bosun_release.md) - Contains sub-commands for releases. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_use.md b/docs/bosun_release_use.md index acd6653..dd17cef 100644 --- a/docs/bosun_release_use.md +++ b/docs/bosun_release_use.md @@ -19,15 +19,17 @@ bosun release use {name} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") - --dry-run Display rendered plans, but do not actually execute (not supported by all commands). - --force Force the requested command to be executed even if heuristics indicate it should not be. - --verbose Enable verbose logging. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. ``` ### SEE ALSO -* [bosun release](bosun_release.md) - Release commands. +* [bosun release](bosun_release.md) - Contains sub-commands for releases. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_release_validate.md b/docs/bosun_release_validate.md index 0d22be2..6f9e7af 100644 --- a/docs/bosun_release_validate.md +++ b/docs/bosun_release_validate.md @@ -4,30 +4,36 @@ Validates the release. ### Synopsis -Validation checks that all apps in this release have a published chart and docker image for this release. +Validation checks that all apps (or the named apps) in the current release have a published chart and docker image. ``` -bosun release validate [flags] +bosun release validate [names...] [flags] ``` ### Options ``` - -h, --help help for validate + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for validate + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. ``` ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") - --dry-run Display rendered plans, but do not actually execute (not supported by all commands). - --force Force the requested command to be executed even if heuristics indicate it should not be. - --verbose Enable verbose logging. + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + -r, --release release use {name} The release to use for this command (overrides current release set with release use {name}). + --verbose Enable verbose logging. ``` ### SEE ALSO -* [bosun release](bosun_release.md) - Release commands. +* [bosun release](bosun_release.md) - Contains sub-commands for releases. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_repo.md b/docs/bosun_repo.md new file mode 100644 index 0000000..c54a0b5 --- /dev/null +++ b/docs/bosun_repo.md @@ -0,0 +1,37 @@ +## bosun repo + +Contains sub-commands for interacting with repos. Has some overlap with the git sub-command. + +### Synopsis + +Most repo sub-commands take one or more optional name parameters. +If no name parameters are provided, the command will attempt to find a repo which +contains the current working path. + +### Options + +``` + -h, --help help for repo +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. +* [bosun repo clone](bosun_repo_clone.md) - Clones the named repo(s). +* [bosun repo fetch](bosun_repo_fetch.md) - Fetches the repo(s). +* [bosun repo list](bosun_repo_list.md) - Lists the known repos and their clone status. +* [bosun repo path](bosun_repo_path.md) - Outputs the path where the repo is cloned on the local system. +* [bosun repo pull](bosun_repo_pull.md) - Pulls the repo(s). + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_repo_clone.md b/docs/bosun_repo_clone.md new file mode 100644 index 0000000..aa458ea --- /dev/null +++ b/docs/bosun_repo_clone.md @@ -0,0 +1,39 @@ +## bosun repo clone + +Clones the named repo(s). + +### Synopsis + +Uses the first directory in `gitRoots` from the root config. + +``` +bosun repo clone {name} [name...] [flags] +``` + +### Options + +``` + --all Will include all items. + --dir org/repo The directory to clone into. (The repo will be cloned into org/repo in this directory.) + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for clone + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun repo](bosun_repo.md) - Contains sub-commands for interacting with repos. Has some overlap with the git sub-command. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_repo_fetch.md b/docs/bosun_repo_fetch.md new file mode 100644 index 0000000..7f690e5 --- /dev/null +++ b/docs/bosun_repo_fetch.md @@ -0,0 +1,38 @@ +## bosun repo fetch + +Fetches the repo(s). + +### Synopsis + +Fetches the repo(s). + +``` +bosun repo fetch [repo] [repo...] [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for fetch + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun repo](bosun_repo.md) - Contains sub-commands for interacting with repos. Has some overlap with the git sub-command. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_repo_list.md b/docs/bosun_repo_list.md new file mode 100644 index 0000000..38b3eb1 --- /dev/null +++ b/docs/bosun_repo_list.md @@ -0,0 +1,38 @@ +## bosun repo list + +Lists the known repos and their clone status. + +### Synopsis + +Lists the known repos and their clone status. + +``` +bosun repo list [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for list + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun repo](bosun_repo.md) - Contains sub-commands for interacting with repos. Has some overlap with the git sub-command. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_repo_path.md b/docs/bosun_repo_path.md new file mode 100644 index 0000000..6d70aae --- /dev/null +++ b/docs/bosun_repo_path.md @@ -0,0 +1,34 @@ +## bosun repo path + +Outputs the path where the repo is cloned on the local system. + +### Synopsis + +Outputs the path where the repo is cloned on the local system. + +``` +bosun repo path {name} [flags] +``` + +### Options + +``` + -h, --help help for path +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun repo](bosun_repo.md) - Contains sub-commands for interacting with repos. Has some overlap with the git sub-command. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_repo_pull.md b/docs/bosun_repo_pull.md new file mode 100644 index 0000000..20ad283 --- /dev/null +++ b/docs/bosun_repo_pull.md @@ -0,0 +1,38 @@ +## bosun repo pull + +Pulls the repo(s). + +### Synopsis + +Pulls the repo(s). + +``` +bosun repo pull [repo] [repo...] [flags] +``` + +### Options + +``` + --all Will include all items. + --exclude strings Will exclude items with labels matching filter (like x==y or x?=prefix-.*). + -h, --help help for pull + --include strings Will include items with labels matching filter (like x==y or x?=prefix-.*). + --labels strings Will include any items where a label with that key is present. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun repo](bosun_repo.md) - Contains sub-commands for interacting with repos. Has some overlap with the git sub-command. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_script.md b/docs/bosun_script.md index 4223df9..04330c8 100644 --- a/docs/bosun_script.md +++ b/docs/bosun_script.md @@ -20,10 +20,11 @@ bosun script {script-file} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +33,4 @@ bosun script {script-file} [flags] * [bosun](bosun.md) - Devops tool. * [bosun script list](bosun_script_list.md) - List scripts from current environment. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_script_list.md b/docs/bosun_script_list.md index 65b0b14..3fe91c2 100644 --- a/docs/bosun_script_list.md +++ b/docs/bosun_script_list.md @@ -19,10 +19,11 @@ bosun script list [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -30,4 +31,4 @@ bosun script list [flags] * [bosun script](bosun_script.md) - Run a scripted sequence of commands. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_tools.md b/docs/bosun_tools.md new file mode 100644 index 0000000..ddd79f9 --- /dev/null +++ b/docs/bosun_tools.md @@ -0,0 +1,32 @@ +## bosun tools + +Commands for listing and installing tools. + +### Synopsis + +Commands for listing and installing tools. + +### Options + +``` + -h, --help help for tools +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. +* [bosun tools install](bosun_tools_install.md) - Installs a tool. +* [bosun tools list](bosun_tools_list.md) - Lists known tools + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_tools_install.md b/docs/bosun_tools_install.md new file mode 100644 index 0000000..33baafb --- /dev/null +++ b/docs/bosun_tools_install.md @@ -0,0 +1,34 @@ +## bosun tools install + +Installs a tool. + +### Synopsis + +Installs a tool. + +``` +bosun tools install {tool} [flags] +``` + +### Options + +``` + -h, --help help for install +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun tools](bosun_tools.md) - Commands for listing and installing tools. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_tools_list.md b/docs/bosun_tools_list.md new file mode 100644 index 0000000..0f2c992 --- /dev/null +++ b/docs/bosun_tools_list.md @@ -0,0 +1,34 @@ +## bosun tools list + +Lists known tools + +### Synopsis + +Lists known tools + +``` +bosun tools list [flags] +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun tools](bosun_tools.md) - Commands for listing and installing tools. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_upgrade.md b/docs/bosun_upgrade.md new file mode 100644 index 0000000..e201d2a --- /dev/null +++ b/docs/bosun_upgrade.md @@ -0,0 +1,35 @@ +## bosun upgrade + +Upgrades bosun if a newer release is available + +### Synopsis + +Upgrades bosun if a newer release is available + +``` +bosun upgrade [flags] +``` + +### Options + +``` + -h, --help help for upgrade + -p, --pre-release Upgrade to pre-release version. +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_vault.md b/docs/bosun_vault.md index f3d6786..a9e01b2 100644 --- a/docs/bosun_vault.md +++ b/docs/bosun_vault.md @@ -36,10 +36,11 @@ vault green-auth.yaml green-kube.yaml green-default.yaml ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -51,4 +52,4 @@ vault green-auth.yaml green-kube.yaml green-default.yaml * [bosun vault secret](bosun_vault_secret.md) - Gets a secret value from vault, optionally populating the value if not found. * [bosun vault unseal](bosun_vault_unseal.md) - Unseals vault using the keys at the provided path, if it exists. Intended to be run from within kubernetes, with the shard secret mounted. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_vault_bootstrap-dev.md b/docs/bosun_vault_bootstrap-dev.md index 6f6a264..0d26640 100644 --- a/docs/bosun_vault_bootstrap-dev.md +++ b/docs/bosun_vault_bootstrap-dev.md @@ -32,10 +32,11 @@ vault bootstrap-dev ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -43,4 +44,4 @@ vault bootstrap-dev * [bosun vault](bosun_vault.md) - Updates VaultClient using layout files. Supports --dry-run flag. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_vault_jwt.md b/docs/bosun_vault_jwt.md index 5be9b13..2160e86 100644 --- a/docs/bosun_vault_jwt.md +++ b/docs/bosun_vault_jwt.md @@ -32,10 +32,11 @@ vault init-dev ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -43,4 +44,4 @@ vault init-dev * [bosun vault](bosun_vault.md) - Updates VaultClient using layout files. Supports --dry-run flag. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_vault_secret.md b/docs/bosun_vault_secret.md index 94ae912..20ec862 100644 --- a/docs/bosun_vault_secret.md +++ b/docs/bosun_vault_secret.md @@ -24,10 +24,11 @@ bosun vault secret {path} [key] [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -35,4 +36,4 @@ bosun vault secret {path} [key] [flags] * [bosun vault](bosun_vault.md) - Updates VaultClient using layout files. Supports --dry-run flag. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_vault_unseal.md b/docs/bosun_vault_unseal.md index 393da34..be55cf7 100644 --- a/docs/bosun_vault_unseal.md +++ b/docs/bosun_vault_unseal.md @@ -21,10 +21,11 @@ bosun vault unseal {path/to/keys} [flags] ### Options inherited from parent commands ``` - --ci-mode Operate in CI mode, reporting deployments and builds to github. - --config-file string Config file for Bosun. (default "$HOME/.bosun/bosun.yaml") + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") --dry-run Display rendered plans, but do not actually execute (not supported by all commands). --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") --verbose Enable verbose logging. ``` @@ -32,4 +33,4 @@ bosun vault unseal {path/to/keys} [flags] * [bosun vault](bosun_vault.md) - Updates VaultClient using layout files. Supports --dry-run flag. -###### Auto generated by spf13/cobra on 27-Dec-2018 +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_workspace.md b/docs/bosun_workspace.md new file mode 100644 index 0000000..493a6ac --- /dev/null +++ b/docs/bosun_workspace.md @@ -0,0 +1,43 @@ +## bosun workspace + +Workspace commands configure and manipulate the bindings between app repos and your local machine. + +### Synopsis + +A workspace contains the core configuration that is used when bosun is run. +It stores the current environment, the current release (if any), a listing of imported bosun files, +the apps discovered in them, and the current state of those apps in the workspace. +The app state includes the location of the app on the file system (for apps which have been cloned) +and the minikube deploy status of the app. + +A workspace is based on a workspace config file. The default location is $HOME/.bosun/bosun.yaml, +but it can be overridden by setting the BOSUN_CONFIG environment variable or passing the --config-file flag. + +### Options + +``` + -h, --help help for workspace +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun](bosun.md) - Devops tool. +* [bosun workspace dump](bosun_workspace_dump.md) - Prints current merged config, or the config of an app. +* [bosun workspace get](bosun_workspace_get.md) - Gets a value in the workspace config. Use a dotted path to reference the value. +* [bosun workspace import](bosun_workspace_import.md) - Includes the file in the user's bosun.yaml. If file is not provided, searches for a bosun.yaml file in this or a parent directory. +* [bosun workspace set](bosun_workspace_set.md) - Sets a value in the workspace config. Use a dotted path to reference the value. +* [bosun workspace show](bosun_workspace_show.md) - Shows various config components. +* [bosun workspace tidy](bosun_workspace_tidy.md) - Cleans up workspace. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_workspace_dump.md b/docs/bosun_workspace_dump.md new file mode 100644 index 0000000..af83b58 --- /dev/null +++ b/docs/bosun_workspace_dump.md @@ -0,0 +1,34 @@ +## bosun workspace dump + +Prints current merged config, or the config of an app. + +### Synopsis + +Prints current merged config, or the config of an app. + +``` +bosun workspace dump [app] [flags] +``` + +### Options + +``` + -h, --help help for dump +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun workspace](bosun_workspace.md) - Workspace commands configure and manipulate the bindings between app repos and your local machine. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_workspace_get.md b/docs/bosun_workspace_get.md new file mode 100644 index 0000000..07f846b --- /dev/null +++ b/docs/bosun_workspace_get.md @@ -0,0 +1,34 @@ +## bosun workspace get + +Gets a value in the workspace config. Use a dotted path to reference the value. + +### Synopsis + +Gets a value in the workspace config. Use a dotted path to reference the value. + +``` +bosun workspace get {JSONPath} [flags] +``` + +### Options + +``` + -h, --help help for get +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun workspace](bosun_workspace.md) - Workspace commands configure and manipulate the bindings between app repos and your local machine. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_workspace_set.md b/docs/bosun_workspace_set.md new file mode 100644 index 0000000..acac5b1 --- /dev/null +++ b/docs/bosun_workspace_set.md @@ -0,0 +1,34 @@ +## bosun workspace set + +Sets a value in the workspace config. Use a dotted path to reference the value. + +### Synopsis + +Sets a value in the workspace config. Use a dotted path to reference the value. + +``` +bosun workspace set {path} {value} [flags] +``` + +### Options + +``` + -h, --help help for set +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun workspace](bosun_workspace.md) - Workspace commands configure and manipulate the bindings between app repos and your local machine. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_workspace_show.md b/docs/bosun_workspace_show.md new file mode 100644 index 0000000..fa8df78 --- /dev/null +++ b/docs/bosun_workspace_show.md @@ -0,0 +1,31 @@ +## bosun workspace show + +Shows various config components. + +### Synopsis + +Shows various config components. + +### Options + +``` + -h, --help help for show +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun workspace](bosun_workspace.md) - Workspace commands configure and manipulate the bindings between app repos and your local machine. +* [bosun workspace show imports](bosun_workspace_show_imports.md) - Prints the imports. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_workspace_show_imports.md b/docs/bosun_workspace_show_imports.md new file mode 100644 index 0000000..4c87c87 --- /dev/null +++ b/docs/bosun_workspace_show_imports.md @@ -0,0 +1,34 @@ +## bosun workspace show imports + +Prints the imports. + +### Synopsis + +Prints the imports. + +``` +bosun workspace show imports [flags] +``` + +### Options + +``` + -h, --help help for imports +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun workspace show](bosun_workspace_show.md) - Shows various config components. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/docs/bosun_workspace_tidy.md b/docs/bosun_workspace_tidy.md new file mode 100644 index 0000000..d39f706 --- /dev/null +++ b/docs/bosun_workspace_tidy.md @@ -0,0 +1,38 @@ +## bosun workspace tidy + +Cleans up workspace. + +### Synopsis + +Cleans up workspace by: +- Removing redundant imports. +- Finding apps which have been cloned into registered git roots. +- Other things as we think of them... + + +``` +bosun workspace tidy [flags] +``` + +### Options + +``` + -h, --help help for tidy +``` + +### Options inherited from parent commands + +``` + --config-file string Config file for Bosun. You can also set BOSUN_CONFIG. (default "$HOME/.bosun/bosun.yaml") + --dry-run Display rendered plans, but do not actually execute (not supported by all commands). + --force Force the requested command to be executed even if heuristics indicate it should not be. + --no-report Disable reporting of deploys to github. + -o, --output table Output format. Options are table, `json`, or `yaml`. Only respected by a some commands. (default "yaml") + --verbose Enable verbose logging. +``` + +### SEE ALSO + +* [bosun workspace](bosun_workspace.md) - Workspace commands configure and manipulate the bindings between app repos and your local machine. + +###### Auto generated by spf13/cobra on 16-May-2019 diff --git a/go.mod b/go.mod index 0b3fce1..2592bc2 100644 --- a/go.mod +++ b/go.mod @@ -36,6 +36,7 @@ require ( github.com/coreos/go-oidc v2.0.0+incompatible // indirect github.com/coreos/go-systemd v0.0.0-20190212144455-93d5ec2c7f76 // indirect github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f // indirect + github.com/cpuguy83/go-md2man v1.0.10 // indirect github.com/dancannon/gorethink v4.0.0+incompatible // indirect github.com/denisenkom/go-mssqldb v0.0.0-20181014144952-4e0d7dc8888f // indirect github.com/dghubble/sling v1.2.0 diff --git a/go.sum b/go.sum index b76e341..e10e0a7 100644 --- a/go.sum +++ b/go.sum @@ -115,6 +115,8 @@ github.com/coreos/go-systemd v0.0.0-20190212144455-93d5ec2c7f76 h1:FE783w8WFh+Rv github.com/coreos/go-systemd v0.0.0-20190212144455-93d5ec2c7f76/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f h1:lBNOc5arjvs8E5mO2tbpBpLoyyu8B6e44T7hJy6potg= github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfcXa63jLwjI0eiQQMgzzUDFVpN/nH/eA= +github.com/cpuguy83/go-md2man v1.0.10 h1:BSKMNlYxDvnunlTymqtgONjNnaRV1sTpcovwwjF22jk= +github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE= github.com/dancannon/gorethink v4.0.0+incompatible h1:KFV7Gha3AuqT+gr0B/eKvGhbjmUv0qGF43aKCIKVE9A= github.com/dancannon/gorethink v4.0.0+incompatible/go.mod h1:BLvkat9KmZc1efyYwhz3WnybhRZtgF1K929FD8z1avU= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= @@ -471,6 +473,7 @@ github.com/prometheus/procfs v0.0.0-20190117184657-bf6a532e95b1/go.mod h1:c3At6R github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg= github.com/rs/xid v1.2.1 h1:mhH9Nq+C1fY2l1XIpgxIiUOfNpRBYH1kKcr+qfKgjRc= github.com/rs/xid v1.2.1/go.mod h1:+uKXf+4Djp6Md1KODXJxgGQPKngRmWyn10oCKFzNHOQ= +github.com/russross/blackfriday v1.5.2 h1:HyvC0ARfnZBqnXwABFeSZHpKvJHJJfPz81GNueLj0oo= github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g= github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735 h1:7YvPJVmEeFHR1Tj9sZEYsmarJEQfMVYpd/Vyy/A8dqE= github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735/go.mod h1:807d1WSdnB0XRJzKNil9Om6lcp/3a0v4qIHxIXzX/Yc=