uffizzi-cli 1.0.4 → 2.0.27
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/config/uffizzi.rb +1 -0
- data/lib/uffizzi/auth_helper.rb +13 -5
- data/lib/uffizzi/cli/account.rb +122 -0
- data/lib/uffizzi/cli/cluster.rb +363 -0
- data/lib/uffizzi/cli/common.rb +2 -4
- data/lib/uffizzi/cli/config.rb +5 -4
- data/lib/uffizzi/cli/connect.rb +14 -8
- data/lib/uffizzi/cli/disconnect.rb +1 -1
- data/lib/uffizzi/cli/login.rb +130 -66
- data/lib/uffizzi/cli/login_by_identity_token.rb +11 -7
- data/lib/uffizzi/cli/preview/service.rb +3 -4
- data/lib/uffizzi/cli/preview.rb +33 -32
- data/lib/uffizzi/cli/project.rb +17 -9
- data/lib/uffizzi/cli.rb +46 -7
- data/lib/uffizzi/clients/api/api_client.rb +92 -2
- data/lib/uffizzi/clients/api/api_routes.rb +44 -0
- data/lib/uffizzi/clients/api/http_client.rb +19 -7
- data/lib/uffizzi/config_file.rb +15 -40
- data/lib/uffizzi/error.rb +15 -0
- data/lib/uffizzi/helpers/config_helper.rb +49 -0
- data/lib/uffizzi/helpers/file_helper.rb +25 -0
- data/lib/uffizzi/helpers/login_helper.rb +33 -0
- data/lib/uffizzi/helpers/project_helper.rb +19 -0
- data/lib/uffizzi/promt.rb +4 -0
- data/lib/uffizzi/response_helper.rb +33 -14
- data/lib/uffizzi/services/cluster_service.rb +59 -0
- data/lib/uffizzi/services/compose_file_service.rb +5 -4
- data/lib/uffizzi/services/env_variables_service.rb +4 -2
- data/lib/uffizzi/services/github_service.rb +21 -0
- data/lib/uffizzi/services/kubeconfig_service.rb +132 -0
- data/lib/uffizzi/services/preview_service.rb +52 -18
- data/lib/uffizzi/shell.rb +19 -16
- data/lib/uffizzi/token.rb +37 -0
- data/lib/uffizzi/version.rb +1 -1
- data/lib/uffizzi.rb +10 -0
- data/man/uffizzi +7 -5
- data/man/uffizzi-account +29 -0
- data/man/uffizzi-account-list +26 -0
- data/man/uffizzi-account-list.html +103 -0
- data/man/uffizzi-account-list.ronn +19 -0
- data/man/uffizzi-account-set-default +29 -0
- data/man/uffizzi-account-set-default.html +105 -0
- data/man/uffizzi-account-set-default.ronn +22 -0
- data/man/uffizzi-account.html +106 -0
- data/man/uffizzi-account.ronn +23 -0
- data/man/uffizzi-cluster +37 -0
- data/man/uffizzi-cluster-create +49 -0
- data/man/uffizzi-cluster-create.ronn +41 -0
- data/man/uffizzi-cluster-delete +32 -0
- data/man/uffizzi-cluster-delete.ronn +24 -0
- data/man/uffizzi-cluster-describe +39 -0
- data/man/uffizzi-cluster-describe.ronn +30 -0
- data/man/uffizzi-cluster-list +34 -0
- data/man/uffizzi-cluster-list.ronn +26 -0
- data/man/uffizzi-cluster-update-kubeconfig +37 -0
- data/man/uffizzi-cluster-update-kubeconfig.ronn +29 -0
- data/man/uffizzi-cluster.ronn +32 -0
- data/man/uffizzi-compose +39 -0
- data/man/uffizzi-compose-create +67 -0
- data/man/uffizzi-compose-create.ronn +57 -0
- data/man/uffizzi-compose-delete +38 -0
- data/man/uffizzi-compose-delete.ronn +29 -0
- data/man/uffizzi-compose-describe +38 -0
- data/man/uffizzi-compose-describe.ronn +29 -0
- data/man/uffizzi-compose-events +38 -0
- data/man/uffizzi-compose-events.ronn +29 -0
- data/man/uffizzi-compose-list +58 -0
- data/man/uffizzi-compose-list.ronn +49 -0
- data/man/uffizzi-compose-service-list +42 -0
- data/man/uffizzi-compose-service-list.ronn +32 -0
- data/man/uffizzi-compose-service-logs +59 -0
- data/man/uffizzi-compose-service-logs.ronn +48 -0
- data/man/uffizzi-compose-update +61 -0
- data/man/uffizzi-compose-update.ronn +51 -0
- data/man/uffizzi-compose.ronn +33 -0
- data/man/uffizzi-compose_service_logs +59 -0
- data/man/uffizzi-compose_service_logs.ronn +50 -0
- data/man/uffizzi-config +2 -2
- data/man/uffizzi-config.ronn +1 -1
- data/man/uffizzi-connect +2 -4
- data/man/uffizzi-connect-acr +2 -2
- data/man/uffizzi-connect-acr.ronn +1 -1
- data/man/uffizzi-connect-docker-hub +2 -2
- data/man/uffizzi-connect-docker-hub.ronn +1 -1
- data/man/uffizzi-connect-docker-registry +2 -2
- data/man/uffizzi-connect-docker-registry.ronn +1 -1
- data/man/uffizzi-connect-ecr +2 -2
- data/man/uffizzi-connect-ecr.ronn +1 -1
- data/man/uffizzi-connect-gcr +2 -2
- data/man/uffizzi-connect-gcr.ronn +1 -1
- data/man/uffizzi-connect-ghcr +2 -2
- data/man/uffizzi-connect-ghcr.ronn +1 -1
- data/man/uffizzi-connect.ronn +2 -2
- data/man/uffizzi-disconnect +2 -2
- data/man/uffizzi-disconnect.ronn +1 -1
- data/man/uffizzi-login +7 -3
- data/man/uffizzi-login-by-identity-token +3 -3
- data/man/uffizzi-login-by-identity-token.ronn +2 -2
- data/man/uffizzi-login.html +113 -0
- data/man/uffizzi-login.ronn +6 -2
- data/man/uffizzi-logout +2 -2
- data/man/uffizzi-logout.ronn +1 -1
- data/man/uffizzi-preview +9 -9
- data/man/uffizzi-preview-create +22 -20
- data/man/uffizzi-preview-create.ronn +28 -26
- data/man/uffizzi-preview-delete +11 -10
- data/man/uffizzi-preview-delete.ronn +12 -11
- data/man/uffizzi-preview-describe +10 -10
- data/man/uffizzi-preview-describe.ronn +11 -11
- data/man/uffizzi-preview-events +12 -11
- data/man/uffizzi-preview-events.ronn +13 -12
- data/man/uffizzi-preview-list +19 -18
- data/man/uffizzi-preview-list.ronn +21 -20
- data/man/uffizzi-preview-service-list +16 -12
- data/man/uffizzi-preview-service-list.ronn +16 -13
- data/man/uffizzi-preview-service-logs +14 -12
- data/man/uffizzi-preview-service-logs.ronn +18 -17
- data/man/uffizzi-preview-update +19 -18
- data/man/uffizzi-preview-update.ronn +21 -20
- data/man/uffizzi-preview.ronn +10 -10
- data/man/uffizzi-preview_service_logs +14 -12
- data/man/uffizzi-preview_service_logs.ronn +18 -17
- data/man/uffizzi-project +3 -3
- data/man/uffizzi-project-compose +2 -2
- data/man/uffizzi-project-compose-describe +2 -2
- data/man/uffizzi-project-compose-describe.ronn +1 -1
- data/man/uffizzi-project-compose-set +2 -2
- data/man/uffizzi-project-compose-set.ronn +1 -1
- data/man/uffizzi-project-compose-unset +2 -2
- data/man/uffizzi-project-compose-unset.ronn +1 -1
- data/man/uffizzi-project-compose.ronn +1 -1
- data/man/uffizzi-project-create +2 -2
- data/man/uffizzi-project-create.ronn +1 -1
- data/man/uffizzi-project-delete +2 -2
- data/man/uffizzi-project-delete.ronn +1 -1
- data/man/uffizzi-project-describe +3 -3
- data/man/uffizzi-project-describe.ronn +1 -1
- data/man/uffizzi-project-preview-describe +37 -0
- data/man/uffizzi-project-preview-describe.ronn +29 -0
- data/man/uffizzi-project-preview-set +66 -0
- data/man/uffizzi-project-preview-set.ronn +57 -0
- data/man/uffizzi-project-secret +2 -2
- data/man/uffizzi-project-secret-create +2 -2
- data/man/uffizzi-project-secret-create.ronn +1 -1
- data/man/uffizzi-project-secret-delete +2 -2
- data/man/uffizzi-project-secret-delete.ronn +1 -1
- data/man/uffizzi-project-secret-list +2 -2
- data/man/uffizzi-project-secret-list.ronn +1 -1
- data/man/uffizzi-project-secret.ronn +1 -1
- data/man/uffizzi-project-set-default +2 -2
- data/man/uffizzi-project-set-default.ronn +1 -1
- data/man/uffizzi-project.html +124 -0
- data/man/uffizzi-project.ronn +2 -2
- data/man/uffizzi.ronn +12 -10
- metadata +131 -19
@@ -0,0 +1,34 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-CLUSTER\-LIST" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-cluster\-list\fR \- list clusters in a project
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi cluster list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Lists all clusters for a project, including active,
|
13
|
+
deploying and failed clusters\.
|
14
|
+
|
15
|
+
For more information on Uffizzi clusters, see:
|
16
|
+
https://docs\.uffizzi\.com/references/cli/
|
17
|
+
.fi
|
18
|
+
.SH "FLAGS"
|
19
|
+
.nf
|
20
|
+
\-\-output=pretty\-json
|
21
|
+
\-\-output=json
|
22
|
+
Use this option for formatting output\.
|
23
|
+
.fi
|
24
|
+
.SH "EXAMPLES"
|
25
|
+
.nf
|
26
|
+
To list all clusters, run:
|
27
|
+
|
28
|
+
$ uffizzi cluster list
|
29
|
+
|
30
|
+
To list all clusters in json format, run:
|
31
|
+
|
32
|
+
$ uffizzi cluster list \-\-output="pretty\-json"
|
33
|
+
.fi
|
34
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
uffizzi-cluster-list - list clusters in a project
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi cluster list [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Lists all clusters for a project, including active,
|
9
|
+
deploying and failed clusters.
|
10
|
+
|
11
|
+
For more information on Uffizzi clusters, see:
|
12
|
+
https://docs.uffizzi.com/references/cli/
|
13
|
+
|
14
|
+
## FLAGS
|
15
|
+
--output=pretty-json
|
16
|
+
--output=json
|
17
|
+
Use this option for formatting output.
|
18
|
+
|
19
|
+
## EXAMPLES
|
20
|
+
To list all clusters, run:
|
21
|
+
|
22
|
+
$ uffizzi cluster list
|
23
|
+
|
24
|
+
To list all clusters in json format, run:
|
25
|
+
|
26
|
+
$ uffizzi cluster list --output="pretty-json"
|
@@ -0,0 +1,37 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-CLUSTER\-UPDATE\-KUBECONFIG" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-cluster\-update\-kubeconfig\fR \- update a kubeconfig
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi cluster update\-kubeconfig [CLUSTER_NAME]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Update your kubeconfig file\.
|
13
|
+
|
14
|
+
This command can fail for the following reasons:
|
15
|
+
\- Your kubeconfig file out of specification
|
16
|
+
|
17
|
+
For more information on Uffizzi clusters, see:
|
18
|
+
https://docs\.uffizzi\.com/references/cli/
|
19
|
+
.fi
|
20
|
+
.SH "FLAGS"
|
21
|
+
.nf
|
22
|
+
\-\-kubeconfig="/path/to/your/kubeconfig"
|
23
|
+
Path to kubeconfig file you want to update
|
24
|
+
|
25
|
+
\-\-print
|
26
|
+
Print kubeconfig to STDOUT without updating kubeconfig file\.
|
27
|
+
|
28
|
+
\-\-quiet
|
29
|
+
Quiet mode
|
30
|
+
.fi
|
31
|
+
.SH "EXAMPLES"
|
32
|
+
.nf
|
33
|
+
To update kubeconfig file, run:
|
34
|
+
|
35
|
+
$ uffizzi cluster update\-kubeconfig \-\-kubeconfig="/file/path/to/kubeconfig"
|
36
|
+
.fi
|
37
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
uffizzi-cluster-update-kubeconfig - update a kubeconfig
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi cluster update-kubeconfig [CLUSTER_NAME]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Update your kubeconfig file.
|
9
|
+
|
10
|
+
This command can fail for the following reasons:
|
11
|
+
- Your kubeconfig file out of specification
|
12
|
+
|
13
|
+
For more information on Uffizzi clusters, see:
|
14
|
+
https://docs.uffizzi.com/references/cli/
|
15
|
+
|
16
|
+
## FLAGS
|
17
|
+
--kubeconfig="/path/to/your/kubeconfig"
|
18
|
+
Path to kubeconfig file you want to update
|
19
|
+
|
20
|
+
--print
|
21
|
+
Print kubeconfig to STDOUT without updating kubeconfig file.
|
22
|
+
|
23
|
+
--quiet
|
24
|
+
Quiet mode
|
25
|
+
|
26
|
+
## EXAMPLES
|
27
|
+
To update kubeconfig file, run:
|
28
|
+
|
29
|
+
$ uffizzi cluster update-kubeconfig --kubeconfig="/file/path/to/kubeconfig"
|
@@ -0,0 +1,32 @@
|
|
1
|
+
uffizzi-cluster - manage clusters
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi cluster COMMAND
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Manage Uffizzi clusters
|
9
|
+
|
10
|
+
For more information on Uffizzi clusters, see:
|
11
|
+
https://docs.uffizzi.com/references/cli/
|
12
|
+
|
13
|
+
## COMMANDS
|
14
|
+
COMMAND is one of the following:
|
15
|
+
|
16
|
+
create
|
17
|
+
Create a cluster
|
18
|
+
|
19
|
+
delete
|
20
|
+
Delete a cluster
|
21
|
+
|
22
|
+
describe
|
23
|
+
Display details of a cluster
|
24
|
+
|
25
|
+
list
|
26
|
+
List all clusters
|
27
|
+
|
28
|
+
update-kubeconfig
|
29
|
+
Update kubeconfig file
|
30
|
+
|
31
|
+
##
|
32
|
+
Run 'uffizzi cluster COMMAND --help' for more information on a command.
|
data/man/uffizzi-compose
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\fR \- manage previews
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Manage Uffizzi previews
|
13
|
+
|
14
|
+
For more information on Uffizzi previews, see:
|
15
|
+
https://docs\.uffizzi\.com/references/cli/
|
16
|
+
.fi
|
17
|
+
.SH "UFFIZZI WIDE FLAGS"
|
18
|
+
.nf
|
19
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
20
|
+
help for details\.
|
21
|
+
.fi
|
22
|
+
.SH "COMMANDS"
|
23
|
+
.nf
|
24
|
+
COMMAND is one of the following:
|
25
|
+
|
26
|
+
create
|
27
|
+
Create a compose environment (preview)
|
28
|
+
|
29
|
+
delete
|
30
|
+
Delete a compose environment (preview)
|
31
|
+
|
32
|
+
describe
|
33
|
+
Display details of a compose environment (preview)
|
34
|
+
|
35
|
+
list
|
36
|
+
List all compose environments (previews)
|
37
|
+
.fi
|
38
|
+
.SH "Run \'uffizzi compose COMMAND \-\-help\' for more information on a command\."
|
39
|
+
|
@@ -0,0 +1,67 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-CREATE" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\-create\fR \- create a compose environment (preview)
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Creates a new compose environment (preview)\. If no COMPOSE_FILE is specified,
|
13
|
+
the compose environment (preview) is created with the project\'s default compose file\.
|
14
|
+
Run $ uffizzi project compose \-\-help for details\.
|
15
|
+
|
16
|
+
This command can fail for the following reasons:
|
17
|
+
\- The project does not have a default compose file set\. Run
|
18
|
+
$ uffizzi compose \-\-help for details\.
|
19
|
+
\- The alternate compose file is invalid\.
|
20
|
+
|
21
|
+
For more information on Uffizzi previews, see:
|
22
|
+
https://docs\.uffizzi\.com/references/cli/
|
23
|
+
.fi
|
24
|
+
.SH "POSITIONAL ARGUMENTS"
|
25
|
+
.nf
|
26
|
+
[COMPOSE_FILE]
|
27
|
+
An alternate compose file to the default compose\.
|
28
|
+
|
29
|
+
You can pass a compose file to this command to create an ad hoc
|
30
|
+
compose environment (preview) of an alternate compose configuration\.
|
31
|
+
The file passed via this argument does not replace the default
|
32
|
+
compose file for the project\. Alternate compose files share the
|
33
|
+
same lifecyle as the previews they create: when the compose
|
34
|
+
environment (preview) is deleted, the alternate compose
|
35
|
+
is deleted by the Uffizzi API\.
|
36
|
+
.fi
|
37
|
+
.SH "FLAGS"
|
38
|
+
.nf
|
39
|
+
\-\-set\-labels=METADATA
|
40
|
+
Metadata of deployment that contains any information which can
|
41
|
+
be useful for filtering deployments\.
|
42
|
+
.fi
|
43
|
+
.SH "UFFIZZI WIDE FLAGS"
|
44
|
+
.nf
|
45
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
46
|
+
help for details\.
|
47
|
+
.fi
|
48
|
+
.SH "EXAMPLES"
|
49
|
+
.nf
|
50
|
+
To create a compose environment (preview) with the project\'s default compose file, run:
|
51
|
+
|
52
|
+
$ uffizzi compose create
|
53
|
+
|
54
|
+
To create a compose environment (preview) with an alternate compose file, run:
|
55
|
+
|
56
|
+
$ uffizzi compose create docker\-compose\.uffizzi\.alt\.yml
|
57
|
+
|
58
|
+
To create a compose environment (preview) with single label, run:
|
59
|
+
|
60
|
+
$ uffizzi compose create \-\-set\-labels github\.repo=my_repo
|
61
|
+
|
62
|
+
To create a compose environment (preview) with multiple labels, run:
|
63
|
+
|
64
|
+
$ uffizzi compose create \e
|
65
|
+
\-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
|
66
|
+
.fi
|
67
|
+
|
@@ -0,0 +1,57 @@
|
|
1
|
+
uffizzi-compose-create - create a compose environment (preview)
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Creates a new compose environment (preview). If no COMPOSE_FILE is specified,
|
9
|
+
the compose environment (preview) is created with the project's default compose file.
|
10
|
+
Run $ uffizzi project compose --help for details.
|
11
|
+
|
12
|
+
This command can fail for the following reasons:
|
13
|
+
- The project does not have a default compose file set. Run
|
14
|
+
$ uffizzi compose --help for details.
|
15
|
+
- The alternate compose file is invalid.
|
16
|
+
|
17
|
+
For more information on Uffizzi previews, see:
|
18
|
+
https://docs.uffizzi.com/references/cli/
|
19
|
+
|
20
|
+
## POSITIONAL ARGUMENTS
|
21
|
+
[COMPOSE_FILE]
|
22
|
+
An alternate compose file to the default compose.
|
23
|
+
|
24
|
+
You can pass a compose file to this command to create an ad hoc
|
25
|
+
compose environment (preview) of an alternate compose configuration.
|
26
|
+
The file passed via this argument does not replace the default
|
27
|
+
compose file for the project. Alternate compose files share the
|
28
|
+
same lifecyle as the previews they create: when the compose
|
29
|
+
environment (preview) is deleted, the alternate compose
|
30
|
+
is deleted by the Uffizzi API.
|
31
|
+
|
32
|
+
## FLAGS
|
33
|
+
--set-labels=METADATA
|
34
|
+
Metadata of deployment that contains any information which can
|
35
|
+
be useful for filtering deployments.
|
36
|
+
|
37
|
+
## UFFIZZI WIDE FLAGS
|
38
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
39
|
+
help for details.
|
40
|
+
|
41
|
+
## EXAMPLES
|
42
|
+
To create a compose environment (preview) with the project's default compose file, run:
|
43
|
+
|
44
|
+
$ uffizzi compose create
|
45
|
+
|
46
|
+
To create a compose environment (preview) with an alternate compose file, run:
|
47
|
+
|
48
|
+
$ uffizzi compose create docker-compose.uffizzi.alt.yml
|
49
|
+
|
50
|
+
To create a compose environment (preview) with single label, run:
|
51
|
+
|
52
|
+
$ uffizzi compose create --set-labels github.repo=my_repo
|
53
|
+
|
54
|
+
To create a compose environment (preview) with multiple labels, run:
|
55
|
+
|
56
|
+
$ uffizzi compose create \
|
57
|
+
--set-labels="github.repo=my_repo github.pull_request.number=23"
|
@@ -0,0 +1,38 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-DELETE" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\-delete\fR \- delete a compose environment (preview)
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Deletes a compose environment (preview) with
|
13
|
+
the given compose environment (preview) ID\.
|
14
|
+
|
15
|
+
This command can fail for the following reasons:
|
16
|
+
\- The compose environment (preview) specified does not exist\.
|
17
|
+
\- The compose environment (preview) specified belongs to a different project\.
|
18
|
+
|
19
|
+
For more information on Uffizzi previews, see:
|
20
|
+
https://docs\.uffizzi\.com/references/cli/
|
21
|
+
.fi
|
22
|
+
.SH "POSITIONAL ARGUMENTS"
|
23
|
+
.nf
|
24
|
+
[PREVIEW_ID]
|
25
|
+
ID for the compose environment (preview) you want to delete\.
|
26
|
+
.fi
|
27
|
+
.SH "UFFIZZI WIDE FLAGS"
|
28
|
+
.nf
|
29
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
30
|
+
help for details\.
|
31
|
+
.fi
|
32
|
+
.SH "EXAMPLES"
|
33
|
+
.nf
|
34
|
+
The following command deletes the compose environment (preview) with ID deployment\-213:
|
35
|
+
|
36
|
+
$ uffizzi compose delete deployment\-213
|
37
|
+
.fi
|
38
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
uffizzi-compose-delete - delete a compose environment (preview)
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Deletes a compose environment (preview) with
|
9
|
+
the given compose environment (preview) ID.
|
10
|
+
|
11
|
+
This command can fail for the following reasons:
|
12
|
+
- The compose environment (preview) specified does not exist.
|
13
|
+
- The compose environment (preview) specified belongs to a different project.
|
14
|
+
|
15
|
+
For more information on Uffizzi previews, see:
|
16
|
+
https://docs.uffizzi.com/references/cli/
|
17
|
+
|
18
|
+
## POSITIONAL ARGUMENTS
|
19
|
+
[PREVIEW_ID]
|
20
|
+
ID for the compose environment (preview) you want to delete.
|
21
|
+
|
22
|
+
## UFFIZZI WIDE FLAGS
|
23
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
24
|
+
help for details.
|
25
|
+
|
26
|
+
## EXAMPLES
|
27
|
+
The following command deletes the compose environment (preview) with ID deployment-213:
|
28
|
+
|
29
|
+
$ uffizzi compose delete deployment-213
|
@@ -0,0 +1,38 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-DESCRIBE" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\-describe\fR \- show metadata for a compose environment (preview)
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Shows metadata for a project given a valid compose environment (preview) ID\.
|
13
|
+
|
14
|
+
This command can fail for the following reasons:
|
15
|
+
\- The compose environment (preview) specified does not exist\.
|
16
|
+
\- The compose environment (preview) specified belongs to a different project\.
|
17
|
+
|
18
|
+
For more information on Uffizzi previews, see:
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
20
|
+
.fi
|
21
|
+
.SH "POSITIONAL ARGUMENTS"
|
22
|
+
.nf
|
23
|
+
[PREVIEW_ID]
|
24
|
+
ID for the compose environment (preview) you want to describe\.
|
25
|
+
.fi
|
26
|
+
.SH "UFFIZZI WIDE FLAGS"
|
27
|
+
.nf
|
28
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
29
|
+
help for details\.
|
30
|
+
.fi
|
31
|
+
.SH "EXAMPLES"
|
32
|
+
.nf
|
33
|
+
The following command prints metadata for the compose environment (preview) with ID
|
34
|
+
deployment\-213:
|
35
|
+
|
36
|
+
$ uffizzi compose describe deployment\-213
|
37
|
+
.fi
|
38
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
uffizzi-compose-describe - show metadata for a compose environment (preview)
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Shows metadata for a project given a valid compose environment (preview) ID.
|
9
|
+
|
10
|
+
This command can fail for the following reasons:
|
11
|
+
- The compose environment (preview) specified does not exist.
|
12
|
+
- The compose environment (preview) specified belongs to a different project.
|
13
|
+
|
14
|
+
For more information on Uffizzi previews, see:
|
15
|
+
https://docs.uffizzi.com/references/cli/
|
16
|
+
|
17
|
+
## POSITIONAL ARGUMENTS
|
18
|
+
[PREVIEW_ID]
|
19
|
+
ID for the compose environment (preview) you want to describe.
|
20
|
+
|
21
|
+
## UFFIZZI WIDE FLAGS
|
22
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
23
|
+
help for details.
|
24
|
+
|
25
|
+
## EXAMPLES
|
26
|
+
The following command prints metadata for the compose environment (preview) with ID
|
27
|
+
deployment-213:
|
28
|
+
|
29
|
+
$ uffizzi compose describe deployment-213
|
@@ -0,0 +1,38 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-EVENTS" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\-events\fR \- show the deployment event logs for a compose environment (preview)
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Shows the deployment event logs for a given compose environment (preview)\.
|
13
|
+
|
14
|
+
This command can fail for the following reasons:
|
15
|
+
\- There is no compose environment (preview) with
|
16
|
+
the given compose environment (preview) ID
|
17
|
+
|
18
|
+
For more information on event logs, see:
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
20
|
+
.fi
|
21
|
+
.SH "POSITIONAL ARGUMENTS"
|
22
|
+
.nf
|
23
|
+
[COMPOSE_ENVIRONMENT_ID]
|
24
|
+
The ID of the compose environment (preview) that you want to see events for\.
|
25
|
+
.fi
|
26
|
+
.SH "UFFIZZI WIDE FLAGS"
|
27
|
+
.nf
|
28
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
29
|
+
help for details\.
|
30
|
+
.fi
|
31
|
+
.SH "EXAMPLES"
|
32
|
+
.nf
|
33
|
+
The following command shows deployment events for
|
34
|
+
the compose environment (preview) with ID deployment\-67:
|
35
|
+
|
36
|
+
$ uffizzi compose events deployment\-67
|
37
|
+
.fi
|
38
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
uffizzi-compose-events - show the deployment event logs for a compose environment (preview)
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Shows the deployment event logs for a given compose environment (preview).
|
9
|
+
|
10
|
+
This command can fail for the following reasons:
|
11
|
+
- There is no compose environment (preview) with
|
12
|
+
the given compose environment (preview) ID
|
13
|
+
|
14
|
+
For more information on event logs, see:
|
15
|
+
https://docs.uffizzi.com/references/cli/
|
16
|
+
|
17
|
+
## POSITIONAL ARGUMENTS
|
18
|
+
[COMPOSE_ENVIRONMENT_ID]
|
19
|
+
The ID of the compose environment (preview) that you want to see events for.
|
20
|
+
|
21
|
+
## UFFIZZI WIDE FLAGS
|
22
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
23
|
+
help for details.
|
24
|
+
|
25
|
+
## EXAMPLES
|
26
|
+
The following command shows deployment events for
|
27
|
+
the compose environment (preview) with ID deployment-67:
|
28
|
+
|
29
|
+
$ uffizzi compose events deployment-67
|
@@ -0,0 +1,58 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-LIST" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\-list\fR \- list compose environments (previews) in a project
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi compose list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
Lists all compose environments (previews) for a project,
|
13
|
+
including active, building, deploying and failed compose
|
14
|
+
environments (previews)\.
|
15
|
+
|
16
|
+
For more information on Uffizzi compose environments (previews), see:
|
17
|
+
https://docs\.uffizzi\.com/references/cli/
|
18
|
+
.fi
|
19
|
+
.SH "FLAGS"
|
20
|
+
.nf
|
21
|
+
\-\-filter=METADATA
|
22
|
+
Metadata to filter list of deployments\.
|
23
|
+
|
24
|
+
\-\-output=pretty\-json
|
25
|
+
Use this option for a more detailed description of listed
|
26
|
+
deployments\.
|
27
|
+
.fi
|
28
|
+
.SH "UFFIZZI WIDE FLAGS"
|
29
|
+
.nf
|
30
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
31
|
+
help for details\.
|
32
|
+
.fi
|
33
|
+
.SH "EXAMPLES"
|
34
|
+
.nf
|
35
|
+
To list all compose environments (previews) in the default project, run:
|
36
|
+
|
37
|
+
$ uffizzi compose list
|
38
|
+
|
39
|
+
To list all compose environments (previews) in a project with name my_project, run:
|
40
|
+
|
41
|
+
$ uffizzi compose list \-\-project="my_project"
|
42
|
+
|
43
|
+
To list all compose environments (previews) in json format, run:
|
44
|
+
|
45
|
+
$ uffizzi compose list \-\-output="pretty\-json"
|
46
|
+
|
47
|
+
To list all compose environments (previews) filtered by metadata using single
|
48
|
+
label, run:
|
49
|
+
|
50
|
+
$ uffizzi compose list \-\-filter github\.repo=my_repo
|
51
|
+
|
52
|
+
To list all compose environments (previews) filtered by metadata using multiple
|
53
|
+
labels, run:
|
54
|
+
|
55
|
+
$ uffizzi compose list \e
|
56
|
+
\-\-filter="github\.repo=my_repo github\.pull_request\.number=23"
|
57
|
+
.fi
|
58
|
+
|
@@ -0,0 +1,49 @@
|
|
1
|
+
uffizzi-compose-list - list compose environments (previews) in a project
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi compose list [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Lists all compose environments (previews) for a project,
|
9
|
+
including active, building, deploying and failed compose
|
10
|
+
environments (previews).
|
11
|
+
|
12
|
+
For more information on Uffizzi compose environments (previews), see:
|
13
|
+
https://docs.uffizzi.com/references/cli/
|
14
|
+
|
15
|
+
## FLAGS
|
16
|
+
--filter=METADATA
|
17
|
+
Metadata to filter list of deployments.
|
18
|
+
|
19
|
+
--output=pretty-json
|
20
|
+
Use this option for a more detailed description of listed
|
21
|
+
deployments.
|
22
|
+
|
23
|
+
## UFFIZZI WIDE FLAGS
|
24
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
25
|
+
help for details.
|
26
|
+
|
27
|
+
## EXAMPLES
|
28
|
+
To list all compose environments (previews) in the default project, run:
|
29
|
+
|
30
|
+
$ uffizzi compose list
|
31
|
+
|
32
|
+
To list all compose environments (previews) in a project with name my_project, run:
|
33
|
+
|
34
|
+
$ uffizzi compose list --project="my_project"
|
35
|
+
|
36
|
+
To list all compose environments (previews) in json format, run:
|
37
|
+
|
38
|
+
$ uffizzi compose list --output="pretty-json"
|
39
|
+
|
40
|
+
To list all compose environments (previews) filtered by metadata using single
|
41
|
+
label, run:
|
42
|
+
|
43
|
+
$ uffizzi compose list --filter github.repo=my_repo
|
44
|
+
|
45
|
+
To list all compose environments (previews) filtered by metadata using multiple
|
46
|
+
labels, run:
|
47
|
+
|
48
|
+
$ uffizzi compose list \
|
49
|
+
--filter="github.repo=my_repo github.pull_request.number=23"
|
@@ -0,0 +1,42 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-SERVICE\-LIST" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\-service\-list\fR
|
6
|
+
.P
|
7
|
+
uffizzi\-compose\-service\-list \- list the container services of a given compose environment (preview) ================================================================
|
8
|
+
.SH "SYNOPSIS"
|
9
|
+
.nf
|
10
|
+
uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
11
|
+
.fi
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
.nf
|
14
|
+
Shows a list of the container services that make up a given
|
15
|
+
compose environment (preview) deployment\.
|
16
|
+
|
17
|
+
This command can fail for the following reasons:
|
18
|
+
\- There is no compose environment (preview)
|
19
|
+
with the given COMPOSE_ENVIRONMENT_ID
|
20
|
+
|
21
|
+
For more information on preview services, see:
|
22
|
+
https://docs\.uffizzi\.com/references/cli/
|
23
|
+
.fi
|
24
|
+
.SH "POSITIONAL ARGUMENTS"
|
25
|
+
.nf
|
26
|
+
[COMPOSE_ENVIRONMENT_ID]
|
27
|
+
The ID of the compose environment (preview) you want to list services for\.
|
28
|
+
.fi
|
29
|
+
.SH "UFFIZZI WIDE FLAGS"
|
30
|
+
.nf
|
31
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
32
|
+
help for details\.
|
33
|
+
.fi
|
34
|
+
.SH "EXAMPLES"
|
35
|
+
.nf
|
36
|
+
The following command lists the container services
|
37
|
+
for a compose environment (preview) with
|
38
|
+
COMPOSE_ENVIRONMENT_ID deployment\-56:
|
39
|
+
|
40
|
+
$ uffizzi compose service list deployment\-56
|
41
|
+
.fi
|
42
|
+
|