From 2bad8882c440aa22f162d26a2dec6139bc4ce376 Mon Sep 17 00:00:00 2001 From: Zipofar Date: Mon, 14 Aug 2023 15:34:49 +0300 Subject: [PATCH 1/2] Return preview help --- man/uffizzi-preview | 39 +++++++++++++ man/uffizzi-preview-create | 67 +++++++++++++++++++++++ man/uffizzi-preview-create.ronn | 57 +++++++++++++++++++ man/uffizzi-preview-delete | 38 +++++++++++++ man/uffizzi-preview-delete.ronn | 29 ++++++++++ man/uffizzi-preview-describe | 38 +++++++++++++ man/uffizzi-preview-describe.ronn | 29 ++++++++++ man/uffizzi-preview-events | 38 +++++++++++++ man/uffizzi-preview-events.ronn | 29 ++++++++++ man/uffizzi-preview-list | 58 ++++++++++++++++++++ man/uffizzi-preview-list.ronn | 49 +++++++++++++++++ man/uffizzi-preview-service-list | 42 ++++++++++++++ man/uffizzi-preview-service-list.ronn | 32 +++++++++++ man/uffizzi-preview-service-logs | 59 ++++++++++++++++++++ man/uffizzi-preview-service-logs.ronn | 48 ++++++++++++++++ man/uffizzi-preview-update | 61 +++++++++++++++++++++ man/uffizzi-preview-update.ronn | 51 +++++++++++++++++ man/uffizzi-preview.ronn | 33 +++++++++++ man/uffizzi-preview_service_logs | 59 ++++++++++++++++++++ man/uffizzi-preview_service_logs.ronn | 50 +++++++++++++++++ man/uffizzi-project-preview-describe | 37 +++++++++++++ man/uffizzi-project-preview-describe.ronn | 29 ++++++++++ man/uffizzi-project-preview-set | 66 ++++++++++++++++++++++ man/uffizzi-project-preview-set.ronn | 57 +++++++++++++++++++ 24 files changed, 1095 insertions(+) create mode 100644 man/uffizzi-preview create mode 100644 man/uffizzi-preview-create create mode 100644 man/uffizzi-preview-create.ronn create mode 100644 man/uffizzi-preview-delete create mode 100644 man/uffizzi-preview-delete.ronn create mode 100644 man/uffizzi-preview-describe create mode 100644 man/uffizzi-preview-describe.ronn create mode 100644 man/uffizzi-preview-events create mode 100644 man/uffizzi-preview-events.ronn create mode 100644 man/uffizzi-preview-list create mode 100644 man/uffizzi-preview-list.ronn create mode 100644 man/uffizzi-preview-service-list create mode 100644 man/uffizzi-preview-service-list.ronn create mode 100644 man/uffizzi-preview-service-logs create mode 100644 man/uffizzi-preview-service-logs.ronn create mode 100644 man/uffizzi-preview-update create mode 100644 man/uffizzi-preview-update.ronn create mode 100644 man/uffizzi-preview.ronn create mode 100644 man/uffizzi-preview_service_logs create mode 100644 man/uffizzi-preview_service_logs.ronn create mode 100644 man/uffizzi-project-preview-describe create mode 100644 man/uffizzi-project-preview-describe.ronn create mode 100644 man/uffizzi-project-preview-set create mode 100644 man/uffizzi-project-preview-set.ronn diff --git a/man/uffizzi-preview b/man/uffizzi-preview new file mode 100644 index 00000000..28466cff --- /dev/null +++ b/man/uffizzi-preview @@ -0,0 +1,39 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-COMPOSE" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-compose\fR \- manage previews +.SH "SYNOPSIS" +.nf +uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Manage Uffizzi previews + +For more information on Uffizzi previews, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "COMMANDS" +.nf +COMMAND is one of the following: + + create + Create a compose environment (preview) + + delete + Delete a compose environment (preview) + + describe + Display details of a compose environment (preview) + + list + List all compose environments (previews) +.fi +.SH "Run \'uffizzi compose COMMAND \-\-help\' for more information on a command\." + diff --git a/man/uffizzi-preview-create b/man/uffizzi-preview-create new file mode 100644 index 00000000..0dc09580 --- /dev/null +++ b/man/uffizzi-preview-create @@ -0,0 +1,67 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-COMPOSE\-CREATE" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-compose\-create\fR \- create a compose environment (preview) +.SH "SYNOPSIS" +.nf +uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Creates a new compose environment (preview)\. If no COMPOSE_FILE is specified, +the compose environment (preview) is created with the project\'s default compose file\. +Run $ uffizzi project compose \-\-help for details\. + +This command can fail for the following reasons: + \- The project does not have a default compose file set\. Run + $ uffizzi compose \-\-help for details\. + \- The alternate compose file is invalid\. + +For more information on Uffizzi previews, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[COMPOSE_FILE] + An alternate compose file to the default compose\. + + You can pass a compose file to this command to create an ad hoc + compose environment (preview) of an alternate compose configuration\. + The file passed via this argument does not replace the default + compose file for the project\. Alternate compose files share the + same lifecyle as the previews they create: when the compose + environment (preview) is deleted, the alternate compose + is deleted by the Uffizzi API\. +.fi +.SH "FLAGS" +.nf +\-\-set\-labels=METADATA + Metadata of deployment that contains any information which can + be useful for filtering deployments\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +To create a compose environment (preview) with the project\'s default compose file, run: + + $ uffizzi compose create + +To create a compose environment (preview) with an alternate compose file, run: + + $ uffizzi compose create docker\-compose\.uffizzi\.alt\.yml + +To create a compose environment (preview) with single label, run: + + $ uffizzi compose create \-\-set\-labels github\.repo=my_repo + +To create a compose environment (preview) with multiple labels, run: + + $ uffizzi compose create \e + \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23" +.fi + diff --git a/man/uffizzi-preview-create.ronn b/man/uffizzi-preview-create.ronn new file mode 100644 index 00000000..3d338e06 --- /dev/null +++ b/man/uffizzi-preview-create.ronn @@ -0,0 +1,57 @@ +uffizzi-compose-create - create a compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Creates a new compose environment (preview). If no COMPOSE_FILE is specified, + the compose environment (preview) is created with the project's default compose file. + Run $ uffizzi project compose --help for details. + + This command can fail for the following reasons: + - The project does not have a default compose file set. Run + $ uffizzi compose --help for details. + - The alternate compose file is invalid. + + For more information on Uffizzi previews, see: + https://docs.uffizzi.com/references/cli/ + +## POSITIONAL ARGUMENTS + [COMPOSE_FILE] + An alternate compose file to the default compose. + + You can pass a compose file to this command to create an ad hoc + compose environment (preview) of an alternate compose configuration. + The file passed via this argument does not replace the default + compose file for the project. Alternate compose files share the + same lifecyle as the previews they create: when the compose + environment (preview) is deleted, the alternate compose + is deleted by the Uffizzi API. + +## FLAGS + --set-labels=METADATA + Metadata of deployment that contains any information which can + be useful for filtering deployments. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + To create a compose environment (preview) with the project's default compose file, run: + + $ uffizzi compose create + + To create a compose environment (preview) with an alternate compose file, run: + + $ uffizzi compose create docker-compose.uffizzi.alt.yml + + To create a compose environment (preview) with single label, run: + + $ uffizzi compose create --set-labels github.repo=my_repo + + To create a compose environment (preview) with multiple labels, run: + + $ uffizzi compose create \ + --set-labels="github.repo=my_repo github.pull_request.number=23" diff --git a/man/uffizzi-preview-delete b/man/uffizzi-preview-delete new file mode 100644 index 00000000..9cf0d66e --- /dev/null +++ b/man/uffizzi-preview-delete @@ -0,0 +1,38 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-COMPOSE\-DELETE" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-compose\-delete\fR \- delete a compose environment (preview) +.SH "SYNOPSIS" +.nf +uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Deletes a compose environment (preview) with +the given compose environment (preview) ID\. + +This command can fail for the following reasons: + \- The compose environment (preview) specified does not exist\. + \- The compose environment (preview) specified belongs to a different project\. + +For more information on Uffizzi previews, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[PREVIEW_ID] + ID for the compose environment (preview) you want to delete\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command deletes the compose environment (preview) with ID deployment\-213: + + $ uffizzi compose delete deployment\-213 +.fi + diff --git a/man/uffizzi-preview-delete.ronn b/man/uffizzi-preview-delete.ronn new file mode 100644 index 00000000..8a33c3a1 --- /dev/null +++ b/man/uffizzi-preview-delete.ronn @@ -0,0 +1,29 @@ +uffizzi-compose-delete - delete a compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Deletes a compose environment (preview) with + the given compose environment (preview) ID. + + This command can fail for the following reasons: + - The compose environment (preview) specified does not exist. + - The compose environment (preview) specified belongs to a different project. + + For more information on Uffizzi previews, see: + https://docs.uffizzi.com/references/cli/ + +## POSITIONAL ARGUMENTS + [PREVIEW_ID] + ID for the compose environment (preview) you want to delete. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command deletes the compose environment (preview) with ID deployment-213: + + $ uffizzi compose delete deployment-213 diff --git a/man/uffizzi-preview-describe b/man/uffizzi-preview-describe new file mode 100644 index 00000000..97d22e01 --- /dev/null +++ b/man/uffizzi-preview-describe @@ -0,0 +1,38 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-COMPOSE\-DESCRIBE" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-compose\-describe\fR \- show metadata for a compose environment (preview) +.SH "SYNOPSIS" +.nf +uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Shows metadata for a project given a valid compose environment (preview) ID\. + +This command can fail for the following reasons: + \- The compose environment (preview) specified does not exist\. + \- The compose environment (preview) specified belongs to a different project\. + +For more information on Uffizzi previews, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[PREVIEW_ID] + ID for the compose environment (preview) you want to describe\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command prints metadata for the compose environment (preview) with ID +deployment\-213: + + $ uffizzi compose describe deployment\-213 +.fi + diff --git a/man/uffizzi-preview-describe.ronn b/man/uffizzi-preview-describe.ronn new file mode 100644 index 00000000..f4e2b55d --- /dev/null +++ b/man/uffizzi-preview-describe.ronn @@ -0,0 +1,29 @@ +uffizzi-compose-describe - show metadata for a compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Shows metadata for a project given a valid compose environment (preview) ID. + + This command can fail for the following reasons: + - The compose environment (preview) specified does not exist. + - The compose environment (preview) specified belongs to a different project. + + For more information on Uffizzi previews, see: + https://docs.uffizzi.com/references/cli/ + +## POSITIONAL ARGUMENTS + [PREVIEW_ID] + ID for the compose environment (preview) you want to describe. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command prints metadata for the compose environment (preview) with ID + deployment-213: + + $ uffizzi compose describe deployment-213 diff --git a/man/uffizzi-preview-events b/man/uffizzi-preview-events new file mode 100644 index 00000000..6b244008 --- /dev/null +++ b/man/uffizzi-preview-events @@ -0,0 +1,38 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-COMPOSE\-EVENTS" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-compose\-events\fR \- show the deployment event logs for a compose environment (preview) +.SH "SYNOPSIS" +.nf +uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Shows the deployment event logs for a given compose environment (preview)\. + +This command can fail for the following reasons: + \- There is no compose environment (preview) with + the given compose environment (preview) ID + +For more information on event logs, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that you want to see events for\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command shows deployment events for +the compose environment (preview) with ID deployment\-67: + + $ uffizzi compose events deployment\-67 +.fi + diff --git a/man/uffizzi-preview-events.ronn b/man/uffizzi-preview-events.ronn new file mode 100644 index 00000000..1b1cc34a --- /dev/null +++ b/man/uffizzi-preview-events.ronn @@ -0,0 +1,29 @@ +uffizzi-compose-events - show the deployment event logs for a compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Shows the deployment event logs for a given compose environment (preview). + + This command can fail for the following reasons: + - There is no compose environment (preview) with + the given compose environment (preview) ID + + For more information on event logs, see: + https://docs.uffizzi.com/references/cli/ + +## POSITIONAL ARGUMENTS + [COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that you want to see events for. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command shows deployment events for + the compose environment (preview) with ID deployment-67: + + $ uffizzi compose events deployment-67 diff --git a/man/uffizzi-preview-list b/man/uffizzi-preview-list new file mode 100644 index 00000000..5cb9e3d1 --- /dev/null +++ b/man/uffizzi-preview-list @@ -0,0 +1,58 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-COMPOSE\-LIST" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-compose\-list\fR \- list compose environments (previews) in a project +.SH "SYNOPSIS" +.nf +uffizzi compose list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Lists all compose environments (previews) for a project, +including active, building, deploying and failed compose +environments (previews)\. + +For more information on Uffizzi compose environments (previews), see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "FLAGS" +.nf +\-\-filter=METADATA + Metadata to filter list of deployments\. + +\-\-output=pretty\-json + Use this option for a more detailed description of listed + deployments\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +To list all compose environments (previews) in the default project, run: + + $ uffizzi compose list + +To list all compose environments (previews) in a project with name my_project, run: + + $ uffizzi compose list \-\-project="my_project" + +To list all compose environments (previews) in json format, run: + + $ uffizzi compose list \-\-output="pretty\-json" + +To list all compose environments (previews) filtered by metadata using single +label, run: + + $ uffizzi compose list \-\-filter github\.repo=my_repo + +To list all compose environments (previews) filtered by metadata using multiple +labels, run: + + $ uffizzi compose list \e + \-\-filter="github\.repo=my_repo github\.pull_request\.number=23" +.fi + diff --git a/man/uffizzi-preview-list.ronn b/man/uffizzi-preview-list.ronn new file mode 100644 index 00000000..c00ccd73 --- /dev/null +++ b/man/uffizzi-preview-list.ronn @@ -0,0 +1,49 @@ +uffizzi-compose-list - list compose environments (previews) in a project +================================================================ + +## SYNOPSIS + uffizzi compose list [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Lists all compose environments (previews) for a project, + including active, building, deploying and failed compose + environments (previews). + + For more information on Uffizzi compose environments (previews), see: + https://docs.uffizzi.com/references/cli/ + +## FLAGS + --filter=METADATA + Metadata to filter list of deployments. + + --output=pretty-json + Use this option for a more detailed description of listed + deployments. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + To list all compose environments (previews) in the default project, run: + + $ uffizzi compose list + + To list all compose environments (previews) in a project with name my_project, run: + + $ uffizzi compose list --project="my_project" + + To list all compose environments (previews) in json format, run: + + $ uffizzi compose list --output="pretty-json" + + To list all compose environments (previews) filtered by metadata using single + label, run: + + $ uffizzi compose list --filter github.repo=my_repo + + To list all compose environments (previews) filtered by metadata using multiple + labels, run: + + $ uffizzi compose list \ + --filter="github.repo=my_repo github.pull_request.number=23" diff --git a/man/uffizzi-preview-service-list b/man/uffizzi-preview-service-list new file mode 100644 index 00000000..5db58317 --- /dev/null +++ b/man/uffizzi-preview-service-list @@ -0,0 +1,42 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-PREVIEW\-SERVICE\-LIST" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-preview\-service\-list\fR +.P +uffizzi\-compose\-service\-list \- list the container services of a given compose environment (preview) ================================================================ +.SH "SYNOPSIS" +.nf +uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Shows a list of the container services that make up a given +compose environment (preview) deployment\. + +This command can fail for the following reasons: + \- There is no compose environment (preview) + with the given COMPOSE_ENVIRONMENT_ID + +For more information on preview services, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) you want to list services for\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command lists the container services +for a compose environment (preview) with +COMPOSE_ENVIRONMENT_ID deployment\-56: + + $ uffizzi compose service list deployment\-56 +.fi + diff --git a/man/uffizzi-preview-service-list.ronn b/man/uffizzi-preview-service-list.ronn new file mode 100644 index 00000000..f8ca3086 --- /dev/null +++ b/man/uffizzi-preview-service-list.ronn @@ -0,0 +1,32 @@ + uffizzi-compose-service-list - list the container services + of a given compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Shows a list of the container services that make up a given + compose environment (preview) deployment. + + This command can fail for the following reasons: + - There is no compose environment (preview) + with the given COMPOSE_ENVIRONMENT_ID + + For more information on preview services, see: + https://docs.uffizzi.com/references/cli/ + +## POSITIONAL ARGUMENTS + [COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) you want to list services for. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command lists the container services + for a compose environment (preview) with + COMPOSE_ENVIRONMENT_ID deployment-56: + + $ uffizzi compose service list deployment-56 diff --git a/man/uffizzi-preview-service-logs b/man/uffizzi-preview-service-logs new file mode 100644 index 00000000..0898d3f1 --- /dev/null +++ b/man/uffizzi-preview-service-logs @@ -0,0 +1,59 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-preview\-service\-logs\fR +.P +uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================ +.SH "SYNOPSIS" +.nf +uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Shows the logs for a given container service of a given compose environment (preview)\. + +This command can fail for the following reasons: + \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID + \- There is no service with the name SERVICE + +For more information on service logs, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "LOG_TYPE" +.nf +LOG_TYPE is one of the following: + +build + The build logs of a service\. + +container + The container logs of a service\. +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that includes the service you want to + show logs for\. + +[SERVICE] + The name of the service you want to show logs for\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command shows build logs for the service web\-app of the +compose environment (preview) with ID deployment\-14: + + $ uffizzi compose service logs build deployment\-14 web\-app + +The following command shows container logs for the service postgres\-db of +the compose environment (preview) with ID deployment\-14: + + $ uffizzi compose service logs container deployment\-14 postgres\-db +.fi + diff --git a/man/uffizzi-preview-service-logs.ronn b/man/uffizzi-preview-service-logs.ronn new file mode 100644 index 00000000..d3909a78 --- /dev/null +++ b/man/uffizzi-preview-service-logs.ronn @@ -0,0 +1,48 @@ + uffizzi-compose-service-logs - show the logs for a container service + of a compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Shows the logs for a given container service of a given compose environment (preview). + + This command can fail for the following reasons: + - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID + - There is no service with the name SERVICE + + For more information on service logs, see: + https://docs.uffizzi.com/references/cli/ + +## LOG_TYPE + LOG_TYPE is one of the following: + + build + The build logs of a service. + + container + The container logs of a service. + +## POSITIONAL ARGUMENTS + [COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that includes the service you want to + show logs for. + + [SERVICE] + The name of the service you want to show logs for. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command shows build logs for the service web-app of the + compose environment (preview) with ID deployment-14: + + $ uffizzi compose service logs build deployment-14 web-app + + The following command shows container logs for the service postgres-db of + the compose environment (preview) with ID deployment-14: + + $ uffizzi compose service logs container deployment-14 postgres-db diff --git a/man/uffizzi-preview-update b/man/uffizzi-preview-update new file mode 100644 index 00000000..49596071 --- /dev/null +++ b/man/uffizzi-preview-update @@ -0,0 +1,61 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UPDATE" "" "August 2023" "" +.SH "NAME" +\fBupdate\fR \- update a compose environment (preview) +.SH "SYNOPSIS" +.nf +uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Given a compose environment (preview) ID and new compose file, +update a compose environment (preview)\. Updating a compose +environment (preview) does not change its compose environment (preview) URL\. + +This command can fail for the following reasons: + \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID + \- The COMPOSE_FILE specified is invalid + +For more information on Uffizzi previews, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that you want to update\. + +[COMPOSE_FILE] + The new compose file you want to compose environment (preview)\. +.fi +.SH "FLAGS" +.nf +\-\-set\-labels=METADATA + Metadata of deployment that contains any information which can + be useful for filtering deployments\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command updates a compose environment (preview) +with ID deployment\-67 using compose file docker\-compose\.alt\.yml: + + $ uffizzi compose update deployment\-67 docker\-compose\.alt\.yml + +To update a compose with single label, run: + + $ uffizzi compose update \e + deployment\-67 docker\-compose\.alt\.yml \e + \-\-set\-labels github\.repo=my_repo + +To update a compose with multiple labels, run: + + $ uffizzi compose update \e + deployment\-67 docker\-compose\.alt\.yml \e + \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23" +.fi + diff --git a/man/uffizzi-preview-update.ronn b/man/uffizzi-preview-update.ronn new file mode 100644 index 00000000..2fa26a27 --- /dev/null +++ b/man/uffizzi-preview-update.ronn @@ -0,0 +1,51 @@ +uffizzi compose update - update a compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Given a compose environment (preview) ID and new compose file, + update a compose environment (preview). Updating a compose + environment (preview) does not change its compose environment (preview) URL. + + This command can fail for the following reasons: + - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID + - The COMPOSE_FILE specified is invalid + + For more information on Uffizzi previews, see: + https://docs.uffizzi.com/references/cli/ + +## POSITIONAL ARGUMENTS + [COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that you want to update. + + [COMPOSE_FILE] + The new compose file you want to compose environment (preview). + +## FLAGS + --set-labels=METADATA + Metadata of deployment that contains any information which can + be useful for filtering deployments. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command updates a compose environment (preview) + with ID deployment-67 using compose file docker-compose.alt.yml: + + $ uffizzi compose update deployment-67 docker-compose.alt.yml + + To update a compose with single label, run: + + $ uffizzi compose update \ + deployment-67 docker-compose.alt.yml \ + --set-labels github.repo=my_repo + + To update a compose with multiple labels, run: + + $ uffizzi compose update \ + deployment-67 docker-compose.alt.yml \ + --set-labels="github.repo=my_repo github.pull_request.number=23" diff --git a/man/uffizzi-preview.ronn b/man/uffizzi-preview.ronn new file mode 100644 index 00000000..845e30e9 --- /dev/null +++ b/man/uffizzi-preview.ronn @@ -0,0 +1,33 @@ +uffizzi-compose - manage previews +================================================================ + +## SYNOPSIS + uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Manage Uffizzi previews + + For more information on Uffizzi previews, see: + https://docs.uffizzi.com/references/cli/ + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## COMMANDS + COMMAND is one of the following: + + create + Create a compose environment (preview) + + delete + Delete a compose environment (preview) + + describe + Display details of a compose environment (preview) + + list + List all compose environments (previews) + +## +Run 'uffizzi compose COMMAND --help' for more information on a command. diff --git a/man/uffizzi-preview_service_logs b/man/uffizzi-preview_service_logs new file mode 100644 index 00000000..aa6a7781 --- /dev/null +++ b/man/uffizzi-preview_service_logs @@ -0,0 +1,59 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-PREVIEW_SERVICE_LOGS" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-preview_service_logs\fR +.P +uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================ +.SH "SYNOPSIS" +.nf +uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +Shows the logs for a given container service of a given compose environment (preview)\. + +This command can fail for the following reasons: + \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID + \- There is no service with the name SERVICE + +For more information on service logs, see: +https://docs\.uffizzi\.com/references/cli/ +.fi +.SH "LOG_TYPE" +.nf +LOG_TYPE is one of the following: + +build + The build logs of a service\. + +container + The container logs of a service\. +.fi +.SH "POSITIONAL ARGUMENTS" +.nf +[COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that includes the service you want to + show logs for\. + +[SERVICE] + The name of the service you want to show logs for\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command shows build logs for the service web\-app of the +compose environment (preview) with ID deployment\-14: + + $ uffizzi compose service logs build deployment\-14 web\-app + +The following command shows container logs for the service postgres\-db of +the compose environment (preview) with ID deployment\-14: + + $ uffizzi compose service logs container deployment\-14 postgres\-db +.fi + diff --git a/man/uffizzi-preview_service_logs.ronn b/man/uffizzi-preview_service_logs.ronn new file mode 100644 index 00000000..90955943 --- /dev/null +++ b/man/uffizzi-preview_service_logs.ronn @@ -0,0 +1,50 @@ + uffizzi-compose-service-logs - show the logs for a container service + of a compose environment (preview) +================================================================ + +## SYNOPSIS + uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + Shows the logs for a given container service of a given compose environment (preview). + + This command can fail for the following reasons: + - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID + - There is no service with the name SERVICE + + For more information on service logs, see: + https://docs.uffizzi.com/references/cli/ + +## LOG_TYPE + LOG_TYPE is one of the following: + + build + The build logs of a service. + + container + The container logs of a service. + +## POSITIONAL ARGUMENTS + [COMPOSE_ENVIRONMENT_ID] + The ID of the compose environment (preview) that includes the service you want to + show logs for. + + [SERVICE] + The name of the service you want to show logs for. + + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command shows build logs for the service web-app of the + compose environment (preview) with ID deployment-14: + + $ uffizzi compose service logs build deployment-14 web-app + + The following command shows container logs for the service postgres-db of + the compose environment (preview) with ID deployment-14: + + $ uffizzi compose service logs container deployment-14 postgres-db + diff --git a/man/uffizzi-project-preview-describe b/man/uffizzi-project-preview-describe new file mode 100644 index 00000000..80ddde21 --- /dev/null +++ b/man/uffizzi-project-preview-describe @@ -0,0 +1,37 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-PROJECT\-COMPOSE\-DESCRIBE" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-project\-compose\-describe\fR \- show metadata for a compose file +.SH "SYNOPSIS" +.nf +uffizzi project compose describe [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +By default, shows the contents of the default project’s compose +file\. Use the \-\-project flag to describe the compose file of a +different project\. + +This command can fail for the following reasons: + \- A compose file is not set for the project\. + +For more information on the uffizzi project compose command, see: +https://docs\.uffizzi\.com/references/cli/ + +For more information on the Uffizzi Compose specification, see: +https://docs\.uffizzi\.com/references/compose\-spec +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command prints the contents of the default project’s +compose file: + + $ uffizzi project compose describe +.fi + diff --git a/man/uffizzi-project-preview-describe.ronn b/man/uffizzi-project-preview-describe.ronn new file mode 100644 index 00000000..b29de3aa --- /dev/null +++ b/man/uffizzi-project-preview-describe.ronn @@ -0,0 +1,29 @@ + uffizzi-project-compose-describe - show metadata for a compose file +================================================================ + +## SYNOPSIS + uffizzi project compose describe [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + By default, shows the contents of the default project’s compose + file. Use the --project flag to describe the compose file of a + different project. + + This command can fail for the following reasons: + - A compose file is not set for the project. + + For more information on the uffizzi project compose command, see: + https://docs.uffizzi.com/references/cli/ + + For more information on the Uffizzi Compose specification, see: + https://docs.uffizzi.com/references/compose-spec + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command prints the contents of the default project’s + compose file: + + $ uffizzi project compose describe diff --git a/man/uffizzi-project-preview-set b/man/uffizzi-project-preview-set new file mode 100644 index 00000000..00443735 --- /dev/null +++ b/man/uffizzi-project-preview-set @@ -0,0 +1,66 @@ +.\" generated with Ronn-NG/v0.9.1 +.\" http://github.com/apjanke/ronn-ng/tree/0.9.1 +.TH "UFFIZZI\-PROJECT\-COMPOSE\-SET" "" "August 2023" "" +.SH "NAME" +\fBuffizzi\-project\-compose\-set\fR \- sets the configuration of a project with a compose file +.SH "SYNOPSIS" +.nf +uffizzi project compose set [\-\-repository=REPOSITORY] + [\-\-branch=BRANCH] [\-\-path=PATH_TO_COMPOSE_FILE] + [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.] +.fi +.SH "DESCRIPTION" +.nf +By default, sets the configuration of the default project with the +specified compose file\. Use the \-\-project flag to set the compose +file of a different project\. If already set, this command overrides +the project\'s configuration with the new compose file\. The compose +file must exist within a GitHub repository\. + +This command can fail for the following reasons: + \- The repository, branch, or path to the compose file as + specified does not exist\. + \- uffizzi is not authorized to access the repository\. + Run $ uffizzi connect \-\-help for details about connecting to + external services\. + \- The compose file is invalid\. + +For more information on the uffizzi project compose command, see: +https://docs\.uffizzi\.com/references/cli/ + +For more information on the Uffizzi Compose specification, see: +https://docs\.uffizzi\.com/references/compose\-spec +.fi +.SH "FLAGS" +.nf +\-\-repository=REPOSITORY + The repository that contains the compose file you want to set + for a project\. + +\-\-branch=BRANCH + The branch of the repository that contains the compose file you + want to set for a project\. If not specified, the default branch + as configured on GitHub is used\. + +\-\-path=PATH_TO_COMPOSE_FILE + The path to the compose file that you want to set for a project\. + This compose file is used as the default when creating previews\. + Run $ uffizzi preview \-\-help for details\. +.fi +.SH "UFFIZZI WIDE FLAGS" +.nf +These flags are available to all commands: \-\-project\. Run $ uffizzi +help for details\. +.fi +.SH "EXAMPLES" +.nf +The following command sets a compose file for the default project\. +The compose file (docker\-compose\.uffizzi\.yml) exists in the main +branch of a GitHub repository called example\-app: + + $ uffizzi project compose set \e + \-\-repository="github\.com/example/example\-app" \e + \-\-branch="main" \e + \-\-path="app/docker\-compose\.uffizzi\.yml" +.fi + diff --git a/man/uffizzi-project-preview-set.ronn b/man/uffizzi-project-preview-set.ronn new file mode 100644 index 00000000..9180593a --- /dev/null +++ b/man/uffizzi-project-preview-set.ronn @@ -0,0 +1,57 @@ + uffizzi-project-compose-set - sets the configuration of a project with a compose file +================================================================ + +## SYNOPSIS + uffizzi project compose set [--repository=REPOSITORY] + [--branch=BRANCH] [--path=PATH_TO_COMPOSE_FILE] + [UFFIZZI_WIDE_FLAG ...] + +## DESCRIPTION + By default, sets the configuration of the default project with the + specified compose file. Use the --project flag to set the compose + file of a different project. If already set, this command overrides + the project's configuration with the new compose file. The compose + file must exist within a GitHub repository. + + This command can fail for the following reasons: + - The repository, branch, or path to the compose file as + specified does not exist. + - uffizzi is not authorized to access the repository. + Run $ uffizzi connect --help for details about connecting to + external services. + - The compose file is invalid. + + For more information on the uffizzi project compose command, see: + https://docs.uffizzi.com/references/cli/ + + For more information on the Uffizzi Compose specification, see: + https://docs.uffizzi.com/references/compose-spec + +## FLAGS + --repository=REPOSITORY + The repository that contains the compose file you want to set + for a project. + + --branch=BRANCH + The branch of the repository that contains the compose file you + want to set for a project. If not specified, the default branch + as configured on GitHub is used. + + --path=PATH_TO_COMPOSE_FILE + The path to the compose file that you want to set for a project. + This compose file is used as the default when creating previews. + Run $ uffizzi preview --help for details. + +## UFFIZZI WIDE FLAGS + These flags are available to all commands: --project. Run $ uffizzi + help for details. + +## EXAMPLES + The following command sets a compose file for the default project. + The compose file (docker-compose.uffizzi.yml) exists in the main + branch of a GitHub repository called example-app: + + $ uffizzi project compose set \ + --repository="github.com/example/example-app" \ + --branch="main" \ + --path="app/docker-compose.uffizzi.yml" From a4ecfddc68e1be381e2364da832721944a78d3ce Mon Sep 17 00:00:00 2001 From: Zipofar Date: Mon, 14 Aug 2023 15:36:22 +0300 Subject: [PATCH 2/2] Change version to 2.0.19 --- Gemfile.lock | 2 +- lib/uffizzi/version.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index 948f0bf6..4f34caea 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - uffizzi-cli (2.0.18) + uffizzi-cli (2.0.19) activesupport awesome_print faker diff --git a/lib/uffizzi/version.rb b/lib/uffizzi/version.rb index 7e5fc7ea..9b93c4d6 100644 --- a/lib/uffizzi/version.rb +++ b/lib/uffizzi/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Uffizzi - VERSION = '2.0.18' + VERSION = '2.0.19' end