From 87074a4bbc68a239a20facdc6cbc4c71c8c6093d Mon Sep 17 00:00:00 2001 From: shreddedbacon Date: Fri, 4 Oct 2024 10:01:37 +1000 Subject: [PATCH] docs: start some basic documentation --- Makefile | 26 ++++++-- cmd/root.go | 16 +++++ docs/commands/lagoon-build.md | 57 ++++++++++++++++++ docs/commands/lagoon-build_configuration.md | 52 ++++++++++++++++ .../lagoon-build_configuration_fastly.md | 52 ++++++++++++++++ docs/commands/lagoon-build_identify.md | 60 +++++++++++++++++++ .../lagoon-build_identify_created-ingress.md | 51 ++++++++++++++++ docs/commands/lagoon-build_identify_dbaas.md | 51 ++++++++++++++++ .../commands/lagoon-build_identify_feature.md | 51 ++++++++++++++++ .../lagoon-build_identify_image-builds.md | 51 ++++++++++++++++ .../commands/lagoon-build_identify_ingress.md | 51 ++++++++++++++++ .../lagoon-build_identify_lagoon-services.md | 51 ++++++++++++++++ .../lagoon-build_identify_native-cronjobs.md | 51 ++++++++++++++++ .../lagoon-build_identify_primary-ingress.md | 51 ++++++++++++++++ docs/commands/lagoon-build_tasks.md | 53 ++++++++++++++++ .../lagoon-build_tasks_post-rollout.md | 52 ++++++++++++++++ .../lagoon-build_tasks_pre-rollout.md | 52 ++++++++++++++++ docs/commands/lagoon-build_template.md | 56 +++++++++++++++++ ...on-build_template_autogenerated-ingress.md | 51 ++++++++++++++++ .../lagoon-build_template_backup-schedule.md | 52 ++++++++++++++++ docs/commands/lagoon-build_template_dbaas.md | 51 ++++++++++++++++ .../commands/lagoon-build_template_ingress.md | 51 ++++++++++++++++ .../lagoon-build_template_lagoon-services.md | 51 ++++++++++++++++ docs/commands/lagoon-build_validate.md | 55 +++++++++++++++++ ...ild_validate_docker-compose-with-errors.md | 53 ++++++++++++++++ .../lagoon-build_validate_docker-compose.md | 53 ++++++++++++++++ .../lagoon-build_validate_lagoon-yml.md | 52 ++++++++++++++++ docs/commands/lagoon-build_version.md | 51 ++++++++++++++++ docs/index.md | 3 + go.mod | 2 + go.sum | 2 + mkdocs.yml | 49 +++++++++++++++ 32 files changed, 1455 insertions(+), 5 deletions(-) create mode 100644 docs/commands/lagoon-build.md create mode 100644 docs/commands/lagoon-build_configuration.md create mode 100644 docs/commands/lagoon-build_configuration_fastly.md create mode 100644 docs/commands/lagoon-build_identify.md create mode 100644 docs/commands/lagoon-build_identify_created-ingress.md create mode 100644 docs/commands/lagoon-build_identify_dbaas.md create mode 100644 docs/commands/lagoon-build_identify_feature.md create mode 100644 docs/commands/lagoon-build_identify_image-builds.md create mode 100644 docs/commands/lagoon-build_identify_ingress.md create mode 100644 docs/commands/lagoon-build_identify_lagoon-services.md create mode 100644 docs/commands/lagoon-build_identify_native-cronjobs.md create mode 100644 docs/commands/lagoon-build_identify_primary-ingress.md create mode 100644 docs/commands/lagoon-build_tasks.md create mode 100644 docs/commands/lagoon-build_tasks_post-rollout.md create mode 100644 docs/commands/lagoon-build_tasks_pre-rollout.md create mode 100644 docs/commands/lagoon-build_template.md create mode 100644 docs/commands/lagoon-build_template_autogenerated-ingress.md create mode 100644 docs/commands/lagoon-build_template_backup-schedule.md create mode 100644 docs/commands/lagoon-build_template_dbaas.md create mode 100644 docs/commands/lagoon-build_template_ingress.md create mode 100644 docs/commands/lagoon-build_template_lagoon-services.md create mode 100644 docs/commands/lagoon-build_validate.md create mode 100644 docs/commands/lagoon-build_validate_docker-compose-with-errors.md create mode 100644 docs/commands/lagoon-build_validate_docker-compose.md create mode 100644 docs/commands/lagoon-build_validate_lagoon-yml.md create mode 100644 docs/commands/lagoon-build_version.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/Makefile b/Makefile index 476f10a3..e72ff15a 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,6 @@ VERSION=$(shell echo $(shell git describe --abbrev=0 --tags)+$(shell git rev-parse --short=8 HEAD)) BUILD=$(shell date +%FT%T%z) +GOCMD=go GO_VER=1.22 GOOS=linux GOARCH=amd64 @@ -7,20 +8,35 @@ PKG=github.com/uselagoon/build-deploy-tool LDFLAGS=-w -s -X ${PKG}/cmd.bdtVersion=${VERSION} -X ${PKG}/cmd.bdtBuild=${BUILD} -X "${PKG}/cmd.goVersion=${GO_VER}" test: fmt vet - go clean -testcache && go test -v ./... + $(GOCMD) clean -testcache && $(GOCMD) test -v ./... fmt: - go fmt ./... + $(GOCMD) fmt ./... vet: - go vet ./... + $(GOCMD) vet ./... run: fmt vet - go run ./main.go + $(GOCMD) run ./main.go build: fmt vet - CGO_ENABLED=0 go build -ldflags '${LDFLAGS}' -v + CGO_ENABLED=0 $(GOCMD) build -ldflags '${LDFLAGS}' -v docker-build: DOCKER_BUILDKIT=1 docker build --pull --build-arg GO_VER=${GO_VER} --build-arg VERSION=${VERSION} --build-arg BUILD=${BUILD} --rm -f Dockerfile -t build-deploy-image:local . docker run --entrypoint /bin/bash build-deploy-image:local -c 'build-deploy-tool version' + +docs: test + $(GOCMD) run main.go --docs + +MKDOCS_IMAGE ?= ghcr.io/amazeeio/mkdocs-material +MKDOCS_SERVE_PORT ?= 8000 + +.PHONY: serve +serve: + @echo "Starting container to serve documentation" + @docker run --rm -it \ + -p 127.0.0.1:$(MKDOCS_SERVE_PORT):$(MKDOCS_SERVE_PORT) \ + -v ${PWD}:/docs \ + --entrypoint sh $(MKDOCS_IMAGE) \ + -c 'mkdocs serve --dev-addr=0.0.0.0:$(MKDOCS_SERVE_PORT) -f mkdocs.yml' \ No newline at end of file diff --git a/cmd/root.go b/cmd/root.go index e88ae3cc..9a3b0f6c 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -21,8 +21,11 @@ import ( "os" "github.com/spf13/cobra" + "github.com/spf13/cobra/doc" ) +var docsFlag bool + // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ Use: "lagoon-build", @@ -30,6 +33,16 @@ var rootCmd = &cobra.Command{ Long: `A tool to help with generating Lagoon resources for Lagoon builds This tool will read a .lagoon.yml file and also all the required environment variables from within a Lagoon build to help with generating the resources`, + RunE: func(cmd *cobra.Command, args []string) error { + if docsFlag { + err := doc.GenMarkdownTree(cmd, "docs/commands") + if err != nil { + return err + } + fmt.Println("Documentation updated") + } + return nil + }, } var templateCmd = &cobra.Command{ @@ -99,6 +112,9 @@ func init() { rootCmd.AddCommand(taskCmd) rootCmd.AddCommand(identifyCmd) rootCmd.AddCommand(validateCmd) + rootCmd.Flags().BoolVarP(&docsFlag, "docs", "", false, "Generate docs") + + rootCmd.Flags().MarkHidden("docs") rootCmd.PersistentFlags().StringP("lagoon-yml", "l", ".lagoon.yml", "The .lagoon.yml file to read") diff --git a/docs/commands/lagoon-build.md b/docs/commands/lagoon-build.md new file mode 100644 index 00000000..d7832092 --- /dev/null +++ b/docs/commands/lagoon-build.md @@ -0,0 +1,57 @@ +## lagoon-build + +A tool to help with generating Lagoon resources for Lagoon builds + +### Synopsis + +A tool to help with generating Lagoon resources for Lagoon builds +This tool will read a .lagoon.yml file and also all the required environment variables from +within a Lagoon build to help with generating the resources + +``` +lagoon-build [flags] +``` + +### Options + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + -h, --help help for lagoon-build + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build configuration](lagoon-build_configuration.md) - Generate configurations +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources +* [lagoon-build tasks](lagoon-build_tasks.md) - Run tasks +* [lagoon-build template](lagoon-build_template.md) - Generate templates +* [lagoon-build validate](lagoon-build_validate.md) - Validate resources +* [lagoon-build version](lagoon-build_version.md) - Version information + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_configuration.md b/docs/commands/lagoon-build_configuration.md new file mode 100644 index 00000000..fa0f80a6 --- /dev/null +++ b/docs/commands/lagoon-build_configuration.md @@ -0,0 +1,52 @@ +## lagoon-build configuration + +Generate configurations + +### Synopsis + +Generate any configurations for Lagoon builds + +### Options + +``` + -h, --help help for configuration +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build](lagoon-build.md) - A tool to help with generating Lagoon resources for Lagoon builds +* [lagoon-build configuration fastly](lagoon-build_configuration_fastly.md) - Generate fastly configuration for a specific ingress domain + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_configuration_fastly.md b/docs/commands/lagoon-build_configuration_fastly.md new file mode 100644 index 00000000..14a3a4dd --- /dev/null +++ b/docs/commands/lagoon-build_configuration_fastly.md @@ -0,0 +1,52 @@ +## lagoon-build configuration fastly + +Generate fastly configuration for a specific ingress domain + +``` +lagoon-build configuration fastly [flags] +``` + +### Options + +``` + -D, --domain string The .lagoon.yml file to read + -h, --help help for fastly +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build configuration](lagoon-build_configuration.md) - Generate configurations + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify.md b/docs/commands/lagoon-build_identify.md new file mode 100644 index 00000000..0a3e0309 --- /dev/null +++ b/docs/commands/lagoon-build_identify.md @@ -0,0 +1,60 @@ +## lagoon-build identify + +Identify resources + +### Synopsis + +Identify resources for Lagoon builds + +### Options + +``` + -h, --help help for identify +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build](lagoon-build.md) - A tool to help with generating Lagoon resources for Lagoon builds +* [lagoon-build identify created-ingress](lagoon-build_identify_created-ingress.md) - Identify all created ingress object names for a specific environment +* [lagoon-build identify dbaas](lagoon-build_identify_dbaas.md) - Identify if any dbaas consumers are created +* [lagoon-build identify feature](lagoon-build_identify_feature.md) - Identify if a feature flag has been enabled +* [lagoon-build identify image-builds](lagoon-build_identify_image-builds.md) - Identify the configuration for building images for a Lagoon build +* [lagoon-build identify ingress](lagoon-build_identify_ingress.md) - Identify all ingress for a specific environment +* [lagoon-build identify ingress](lagoon-build_identify_ingress.md) - Identify all ingress for a specific environment +* [lagoon-build identify lagoon-services](lagoon-build_identify_lagoon-services.md) - Identify the lagoon services for a Lagoon build +* [lagoon-build identify native-cronjobs](lagoon-build_identify_native-cronjobs.md) - Identify any native cronjobs for a specific environment +* [lagoon-build identify primary-ingress](lagoon-build_identify_primary-ingress.md) - Identify the primary ingress for a specific environment + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_created-ingress.md b/docs/commands/lagoon-build_identify_created-ingress.md new file mode 100644 index 00000000..112c2b86 --- /dev/null +++ b/docs/commands/lagoon-build_identify_created-ingress.md @@ -0,0 +1,51 @@ +## lagoon-build identify created-ingress + +Identify all created ingress object names for a specific environment + +``` +lagoon-build identify created-ingress [flags] +``` + +### Options + +``` + -h, --help help for created-ingress +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_dbaas.md b/docs/commands/lagoon-build_identify_dbaas.md new file mode 100644 index 00000000..232080a6 --- /dev/null +++ b/docs/commands/lagoon-build_identify_dbaas.md @@ -0,0 +1,51 @@ +## lagoon-build identify dbaas + +Identify if any dbaas consumers are created + +``` +lagoon-build identify dbaas [flags] +``` + +### Options + +``` + -h, --help help for dbaas +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_feature.md b/docs/commands/lagoon-build_identify_feature.md new file mode 100644 index 00000000..89a3c3fa --- /dev/null +++ b/docs/commands/lagoon-build_identify_feature.md @@ -0,0 +1,51 @@ +## lagoon-build identify feature + +Identify if a feature flag has been enabled + +``` +lagoon-build identify feature [flags] +``` + +### Options + +``` + -h, --help help for feature +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_image-builds.md b/docs/commands/lagoon-build_identify_image-builds.md new file mode 100644 index 00000000..3c8ca9b8 --- /dev/null +++ b/docs/commands/lagoon-build_identify_image-builds.md @@ -0,0 +1,51 @@ +## lagoon-build identify image-builds + +Identify the configuration for building images for a Lagoon build + +``` +lagoon-build identify image-builds [flags] +``` + +### Options + +``` + -h, --help help for image-builds +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_ingress.md b/docs/commands/lagoon-build_identify_ingress.md new file mode 100644 index 00000000..f5ef9478 --- /dev/null +++ b/docs/commands/lagoon-build_identify_ingress.md @@ -0,0 +1,51 @@ +## lagoon-build identify ingress + +Identify all ingress for a specific environment + +``` +lagoon-build identify ingress [flags] +``` + +### Options + +``` + -h, --help help for ingress +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_lagoon-services.md b/docs/commands/lagoon-build_identify_lagoon-services.md new file mode 100644 index 00000000..d7e79fb6 --- /dev/null +++ b/docs/commands/lagoon-build_identify_lagoon-services.md @@ -0,0 +1,51 @@ +## lagoon-build identify lagoon-services + +Identify the lagoon services for a Lagoon build + +``` +lagoon-build identify lagoon-services [flags] +``` + +### Options + +``` + -h, --help help for lagoon-services +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_native-cronjobs.md b/docs/commands/lagoon-build_identify_native-cronjobs.md new file mode 100644 index 00000000..6d430a5b --- /dev/null +++ b/docs/commands/lagoon-build_identify_native-cronjobs.md @@ -0,0 +1,51 @@ +## lagoon-build identify native-cronjobs + +Identify any native cronjobs for a specific environment + +``` +lagoon-build identify native-cronjobs [flags] +``` + +### Options + +``` + -h, --help help for native-cronjobs +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_identify_primary-ingress.md b/docs/commands/lagoon-build_identify_primary-ingress.md new file mode 100644 index 00000000..3956630a --- /dev/null +++ b/docs/commands/lagoon-build_identify_primary-ingress.md @@ -0,0 +1,51 @@ +## lagoon-build identify primary-ingress + +Identify the primary ingress for a specific environment + +``` +lagoon-build identify primary-ingress [flags] +``` + +### Options + +``` + -h, --help help for primary-ingress +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build identify](lagoon-build_identify.md) - Identify resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_tasks.md b/docs/commands/lagoon-build_tasks.md new file mode 100644 index 00000000..96ba2b35 --- /dev/null +++ b/docs/commands/lagoon-build_tasks.md @@ -0,0 +1,53 @@ +## lagoon-build tasks + +Run tasks + +### Synopsis + +Will run Pre/Post/etc. tasks defined in a .lagoon.yml + +### Options + +``` + -h, --help help for tasks +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build](lagoon-build.md) - A tool to help with generating Lagoon resources for Lagoon builds +* [lagoon-build tasks post-rollout](lagoon-build_tasks_post-rollout.md) - Will run post rollout tasks defined in .lagoon.yml +* [lagoon-build tasks pre-rollout](lagoon-build_tasks_pre-rollout.md) - Will run pre rollout tasks defined in .lagoon.yml + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_tasks_post-rollout.md b/docs/commands/lagoon-build_tasks_post-rollout.md new file mode 100644 index 00000000..93e39196 --- /dev/null +++ b/docs/commands/lagoon-build_tasks_post-rollout.md @@ -0,0 +1,52 @@ +## lagoon-build tasks post-rollout + +Will run post rollout tasks defined in .lagoon.yml + +``` +lagoon-build tasks post-rollout [flags] +``` + +### Options + +``` + -h, --help help for post-rollout + -n, --namespace string The environments environment variables JSON payload +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build tasks](lagoon-build_tasks.md) - Run tasks + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_tasks_pre-rollout.md b/docs/commands/lagoon-build_tasks_pre-rollout.md new file mode 100644 index 00000000..286e4343 --- /dev/null +++ b/docs/commands/lagoon-build_tasks_pre-rollout.md @@ -0,0 +1,52 @@ +## lagoon-build tasks pre-rollout + +Will run pre rollout tasks defined in .lagoon.yml + +``` +lagoon-build tasks pre-rollout [flags] +``` + +### Options + +``` + -h, --help help for pre-rollout + -n, --namespace string The environments environment variables JSON payload +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build tasks](lagoon-build_tasks.md) - Run tasks + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_template.md b/docs/commands/lagoon-build_template.md new file mode 100644 index 00000000..f0df90c1 --- /dev/null +++ b/docs/commands/lagoon-build_template.md @@ -0,0 +1,56 @@ +## lagoon-build template + +Generate templates + +### Synopsis + +Generate any templates for Lagoon builds + +### Options + +``` + -h, --help help for template +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build](lagoon-build.md) - A tool to help with generating Lagoon resources for Lagoon builds +* [lagoon-build template autogenerated-ingress](lagoon-build_template_autogenerated-ingress.md) - Generate the autogenerated ingress templates for a Lagoon build +* [lagoon-build template backup-schedule](lagoon-build_template_backup-schedule.md) - Generate the backup schedule templates for a Lagoon build +* [lagoon-build template dbaas](lagoon-build_template_dbaas.md) - Generate the DBaaS templates for a Lagoon build +* [lagoon-build template ingress](lagoon-build_template_ingress.md) - Generate the ingress templates for a Lagoon build +* [lagoon-build template lagoon-services](lagoon-build_template_lagoon-services.md) - Generate the lagoon service templates for a Lagoon build + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_template_autogenerated-ingress.md b/docs/commands/lagoon-build_template_autogenerated-ingress.md new file mode 100644 index 00000000..2645924e --- /dev/null +++ b/docs/commands/lagoon-build_template_autogenerated-ingress.md @@ -0,0 +1,51 @@ +## lagoon-build template autogenerated-ingress + +Generate the autogenerated ingress templates for a Lagoon build + +``` +lagoon-build template autogenerated-ingress [flags] +``` + +### Options + +``` + -h, --help help for autogenerated-ingress +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build template](lagoon-build_template.md) - Generate templates + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_template_backup-schedule.md b/docs/commands/lagoon-build_template_backup-schedule.md new file mode 100644 index 00000000..09a9e7f4 --- /dev/null +++ b/docs/commands/lagoon-build_template_backup-schedule.md @@ -0,0 +1,52 @@ +## lagoon-build template backup-schedule + +Generate the backup schedule templates for a Lagoon build + +``` +lagoon-build template backup-schedule [flags] +``` + +### Options + +``` + -h, --help help for backup-schedule + --version string The version of k8up used. (default "v1") +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build template](lagoon-build_template.md) - Generate templates + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_template_dbaas.md b/docs/commands/lagoon-build_template_dbaas.md new file mode 100644 index 00000000..78d8ea4d --- /dev/null +++ b/docs/commands/lagoon-build_template_dbaas.md @@ -0,0 +1,51 @@ +## lagoon-build template dbaas + +Generate the DBaaS templates for a Lagoon build + +``` +lagoon-build template dbaas [flags] +``` + +### Options + +``` + -h, --help help for dbaas +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build template](lagoon-build_template.md) - Generate templates + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_template_ingress.md b/docs/commands/lagoon-build_template_ingress.md new file mode 100644 index 00000000..df9b8bc1 --- /dev/null +++ b/docs/commands/lagoon-build_template_ingress.md @@ -0,0 +1,51 @@ +## lagoon-build template ingress + +Generate the ingress templates for a Lagoon build + +``` +lagoon-build template ingress [flags] +``` + +### Options + +``` + -h, --help help for ingress +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build template](lagoon-build_template.md) - Generate templates + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_template_lagoon-services.md b/docs/commands/lagoon-build_template_lagoon-services.md new file mode 100644 index 00000000..6de2dd8a --- /dev/null +++ b/docs/commands/lagoon-build_template_lagoon-services.md @@ -0,0 +1,51 @@ +## lagoon-build template lagoon-services + +Generate the lagoon service templates for a Lagoon build + +``` +lagoon-build template lagoon-services [flags] +``` + +### Options + +``` + -h, --help help for lagoon-services +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build template](lagoon-build_template.md) - Generate templates + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_validate.md b/docs/commands/lagoon-build_validate.md new file mode 100644 index 00000000..a8337f3a --- /dev/null +++ b/docs/commands/lagoon-build_validate.md @@ -0,0 +1,55 @@ +## lagoon-build validate + +Validate resources + +### Synopsis + +Validate resources for Lagoon builds + +### Options + +``` + -h, --help help for validate + --print-resulting-lagoonyml Display the resulting, post merging, lagoon.yml file. +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build](lagoon-build.md) - A tool to help with generating Lagoon resources for Lagoon builds +* [lagoon-build validate docker-compose](lagoon-build_validate_docker-compose.md) - Verify docker-compose file for compatability with this tool +* [lagoon-build validate docker-compose-with-errors](lagoon-build_validate_docker-compose-with-errors.md) - Verify docker-compose file for compatability with this tool with next versions of compose-go library +* [lagoon-build validate lagoon-yml](lagoon-build_validate_lagoon-yml.md) - Verify .lagoon.yml and environment for compatability with this tool + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_validate_docker-compose-with-errors.md b/docs/commands/lagoon-build_validate_docker-compose-with-errors.md new file mode 100644 index 00000000..f066a7e4 --- /dev/null +++ b/docs/commands/lagoon-build_validate_docker-compose-with-errors.md @@ -0,0 +1,53 @@ +## lagoon-build validate docker-compose-with-errors + +Verify docker-compose file for compatability with this tool with next versions of compose-go library + +``` +lagoon-build validate docker-compose-with-errors [flags] +``` + +### Options + +``` + --docker-compose string The docker-compose.yml file to read. (default "docker-compose.yml") + -h, --help help for docker-compose-with-errors +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + --print-resulting-lagoonyml Display the resulting, post merging, lagoon.yml file. + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build validate](lagoon-build_validate.md) - Validate resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_validate_docker-compose.md b/docs/commands/lagoon-build_validate_docker-compose.md new file mode 100644 index 00000000..83cc3a4f --- /dev/null +++ b/docs/commands/lagoon-build_validate_docker-compose.md @@ -0,0 +1,53 @@ +## lagoon-build validate docker-compose + +Verify docker-compose file for compatability with this tool + +``` +lagoon-build validate docker-compose [flags] +``` + +### Options + +``` + --docker-compose string The docker-compose.yml file to read. (default "docker-compose.yml") + -h, --help help for docker-compose +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + --print-resulting-lagoonyml Display the resulting, post merging, lagoon.yml file. + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build validate](lagoon-build_validate.md) - Validate resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_validate_lagoon-yml.md b/docs/commands/lagoon-build_validate_lagoon-yml.md new file mode 100644 index 00000000..e783c523 --- /dev/null +++ b/docs/commands/lagoon-build_validate_lagoon-yml.md @@ -0,0 +1,52 @@ +## lagoon-build validate lagoon-yml + +Verify .lagoon.yml and environment for compatability with this tool + +``` +lagoon-build validate lagoon-yml [flags] +``` + +### Options + +``` + -h, --help help for lagoon-yml +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + --print-resulting-lagoonyml Display the resulting, post merging, lagoon.yml file. + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build validate](lagoon-build_validate.md) - Validate resources + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/commands/lagoon-build_version.md b/docs/commands/lagoon-build_version.md new file mode 100644 index 00000000..ac84558a --- /dev/null +++ b/docs/commands/lagoon-build_version.md @@ -0,0 +1,51 @@ +## lagoon-build version + +Version information + +``` +lagoon-build version [flags] +``` + +### Options + +``` + -h, --help help for version +``` + +### Options inherited from parent commands + +``` + -a, --active-environment string Name of the active environment if known + -b, --branch string The name of the branch + -d, --build-type string The type of build (branch, pullrequest, promote) + --default-backup-schedule string The default backup schedule to use + -e, --environment-name string The environment name to check + -E, --environment-type string The type of environment (development or production) + --environment-variables string The JSON payload for environment scope variables + -A, --fastly-api-secret-prefix string The fastly secret prefix to use (default "fastly-api-") + -F, --fastly-cache-no-cache-id string The fastly cache no cache service ID to use + -f, --fastly-service-id string The fastly service ID to use + --ignore-missing-env-files Ignore missing env_file files (true by default, subject to change). (default true) + --ignore-non-string-key-errors Ignore non-string-key docker-compose errors (true by default, subject to change). (default true) + --images string JSON representation of service:image reference + -L, --lagoon-version string The lagoon version + -l, --lagoon-yml string The .lagoon.yml file to read (default ".lagoon.yml") + --lagoon-yml-override string The .lagoon.yml override file to read for merging values into target lagoon.yml (default ".lagoon.override.yml") + -M, --monitoring-config string The monitoring contact config if known + -m, --monitoring-status-page-id string The monitoring status page ID if known + -p, --project-name string The project name + --project-variables string The JSON payload for project scope variables + -B, --pullrequest-base-branch string The pullrequest base branch + -H, --pullrequest-head-branch string The pullrequest head branch + -P, --pullrequest-number string The pullrequest number + --pullrequest-title string The pullrequest title + -T, --saved-templates-path string Path to where the resulting templates are saved (default "/kubectl-build-deploy/lagoon/services-routes") + -s, --standby-environment string Name of the standby environment if known + -t, --template-path string Path to the template on disk (default "/kubectl-build-deploy/") +``` + +### SEE ALSO + +* [lagoon-build](lagoon-build.md) - A tool to help with generating Lagoon resources for Lagoon builds + +###### Auto generated by spf13/cobra on 4-Oct-2024 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..71612144 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Introduction + +This is a tool used with a [Lagoon Build](https://docs.lagoon.sh/concepts-basics/build-and-deploy-process/). It is currently not intended to be used outside of a build process. diff --git a/go.mod b/go.mod index d5b3cf66..9d7b09b6 100644 --- a/go.mod +++ b/go.mod @@ -29,6 +29,7 @@ require ( ) require ( + github.com/cpuguy83/go-md2man/v2 v2.0.4 // indirect github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect github.com/distribution/distribution/v3 v3.0.0-20210316161203-a01c71e2477e // indirect github.com/docker/go-connections v0.5.0 // indirect @@ -61,6 +62,7 @@ require ( github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f // indirect github.com/opencontainers/go-digest v1.0.0 // indirect github.com/pkg/errors v0.9.1 // indirect + github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/sergi/go-diff v1.1.0 // indirect github.com/shopspring/decimal v1.4.0 // indirect github.com/sirupsen/logrus v1.9.3 // indirect diff --git a/go.sum b/go.sum index 4df037a8..4b142d6d 100644 --- a/go.sum +++ b/go.sum @@ -129,6 +129,7 @@ github.com/coreos/pkg v0.0.0-20180928190104-399ea9e2e55f/go.mod h1:E3G3o1h8I7cfc github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4= github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= @@ -716,6 +717,7 @@ github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4= github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g= github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= github.com/ryanuber/columnize v2.1.0+incompatible/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..642dcd72 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,49 @@ +site_name: 'Lagoon Build Deploy Tool' +site_url: https://uselagoon.github.io/build-deploy-tool/ +repo_url: https://github.com/uselagoon/build-deploy-tool/ +repo_name: uselagoon/build-deploy-tool +edit_uri: edit/main/docs +site_author: The Lagoon Authors + +theme: + name: 'material' + palette: + # Palette toggle for light mode + - primary: 'blue' + accent: 'light blue' + toggle: + icon: material/weather-night + name: Switch to dark mode + # Palette toggle for dark mode + - scheme: slate + primary: 'blue' + toggle: + icon: material/brightness-7 + name: Switch to light mode + # favicon: lagoon-build-icon.png + icon: + logo: fontawesome/solid/terminal + repo: fontawesome/brands/github + +extra: + analytics: + provider: google + property: G-W1SJFEVFDB + +markdown_extensions: + - toc: + permalink: "#" + baselevel: 2 + - admonition + - attr_list + - tables + - pymdownx.highlight + - pymdownx.superfences + +plugins: + - search + +nav: + - Getting Started: index.md + - Build Requirements: buildrequirements.md + - Commands: commands/lagoon-build.md