uffizzi-cli 1.0.4 → 2.0.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
data/man/uffizzi-preview-events
CHANGED
|
@@ -1,26 +1,27 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
-
.TH "UFFIZZI\-
|
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-EVENTS" "" "August 2023" ""
|
|
4
4
|
.SH "NAME"
|
|
5
|
-
\fBuffizzi\-
|
|
5
|
+
\fBuffizzi\-compose\-events\fR \- show the deployment event logs for a compose environment (preview)
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
7
|
.nf
|
|
8
|
-
uffizzi
|
|
8
|
+
uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
9
|
.fi
|
|
10
10
|
.SH "DESCRIPTION"
|
|
11
11
|
.nf
|
|
12
|
-
Shows the deployment event logs for a given preview\.
|
|
12
|
+
Shows the deployment event logs for a given compose environment (preview)\.
|
|
13
13
|
|
|
14
14
|
This command can fail for the following reasons:
|
|
15
|
-
\- There is no preview with
|
|
15
|
+
\- There is no compose environment (preview) with
|
|
16
|
+
the given compose environment (preview) ID
|
|
16
17
|
|
|
17
18
|
For more information on event logs, see:
|
|
18
|
-
https://
|
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
19
20
|
.fi
|
|
20
21
|
.SH "POSITIONAL ARGUMENTS"
|
|
21
22
|
.nf
|
|
22
|
-
[
|
|
23
|
-
The ID of the preview that you want to see events for\.
|
|
23
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
24
|
+
The ID of the compose environment (preview) that you want to see events for\.
|
|
24
25
|
.fi
|
|
25
26
|
.SH "UFFIZZI WIDE FLAGS"
|
|
26
27
|
.nf
|
|
@@ -29,9 +30,9 @@ help for details\.
|
|
|
29
30
|
.fi
|
|
30
31
|
.SH "EXAMPLES"
|
|
31
32
|
.nf
|
|
32
|
-
The following command shows deployment events for
|
|
33
|
-
ID deployment\-67:
|
|
33
|
+
The following command shows deployment events for
|
|
34
|
+
the compose environment (preview) with ID deployment\-67:
|
|
34
35
|
|
|
35
|
-
$ uffizzi
|
|
36
|
+
$ uffizzi compose events deployment\-67
|
|
36
37
|
.fi
|
|
37
38
|
|
|
@@ -1,28 +1,29 @@
|
|
|
1
|
-
uffizzi-
|
|
1
|
+
uffizzi-compose-events - show the deployment event logs for a compose environment (preview)
|
|
2
2
|
================================================================
|
|
3
3
|
|
|
4
4
|
## SYNOPSIS
|
|
5
|
-
uffizzi
|
|
5
|
+
uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
|
|
6
6
|
|
|
7
7
|
## DESCRIPTION
|
|
8
|
-
Shows the deployment event logs for a given preview.
|
|
8
|
+
Shows the deployment event logs for a given compose environment (preview).
|
|
9
9
|
|
|
10
|
-
This command can fail for the following reasons:
|
|
11
|
-
- There is no preview with
|
|
10
|
+
This command can fail for the following reasons:
|
|
11
|
+
- There is no compose environment (preview) with
|
|
12
|
+
the given compose environment (preview) ID
|
|
12
13
|
|
|
13
14
|
For more information on event logs, see:
|
|
14
|
-
https://
|
|
15
|
+
https://docs.uffizzi.com/references/cli/
|
|
15
16
|
|
|
16
17
|
## POSITIONAL ARGUMENTS
|
|
17
|
-
[
|
|
18
|
-
The ID of the preview that you want to see events for.
|
|
18
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
19
|
+
The ID of the compose environment (preview) that you want to see events for.
|
|
19
20
|
|
|
20
21
|
## UFFIZZI WIDE FLAGS
|
|
21
|
-
These flags are available to all commands: --project. Run $ uffizzi
|
|
22
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
|
22
23
|
help for details.
|
|
23
24
|
|
|
24
25
|
## EXAMPLES
|
|
25
|
-
The following command shows deployment events for
|
|
26
|
-
ID deployment-67:
|
|
26
|
+
The following command shows deployment events for
|
|
27
|
+
the compose environment (preview) with ID deployment-67:
|
|
27
28
|
|
|
28
|
-
$ uffizzi
|
|
29
|
+
$ uffizzi compose events deployment-67
|
data/man/uffizzi-preview-list
CHANGED
|
@@ -1,24 +1,25 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
-
.TH "UFFIZZI\-
|
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-LIST" "" "August 2023" ""
|
|
4
4
|
.SH "NAME"
|
|
5
|
-
\fBuffizzi\-
|
|
5
|
+
\fBuffizzi\-compose\-list\fR \- list compose environments (previews) in a project
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
7
|
.nf
|
|
8
|
-
uffizzi
|
|
8
|
+
uffizzi compose list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
9
|
.fi
|
|
10
10
|
.SH "DESCRIPTION"
|
|
11
11
|
.nf
|
|
12
|
-
Lists all previews for a project,
|
|
13
|
-
deploying and failed
|
|
12
|
+
Lists all compose environments (previews) for a project,
|
|
13
|
+
including active, building, deploying and failed compose
|
|
14
|
+
environments (previews)\.
|
|
14
15
|
|
|
15
|
-
For more information on Uffizzi previews, see:
|
|
16
|
-
https://
|
|
16
|
+
For more information on Uffizzi compose environments (previews), see:
|
|
17
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
17
18
|
.fi
|
|
18
19
|
.SH "FLAGS"
|
|
19
20
|
.nf
|
|
20
21
|
\-\-filter=METADATA
|
|
21
|
-
Metadata to
|
|
22
|
+
Metadata to filter list of deployments\.
|
|
22
23
|
|
|
23
24
|
\-\-output=pretty\-json
|
|
24
25
|
Use this option for a more detailed description of listed
|
|
@@ -31,27 +32,27 @@ help for details\.
|
|
|
31
32
|
.fi
|
|
32
33
|
.SH "EXAMPLES"
|
|
33
34
|
.nf
|
|
34
|
-
To list all previews in the default project, run:
|
|
35
|
+
To list all compose environments (previews) in the default project, run:
|
|
35
36
|
|
|
36
|
-
$ uffizzi
|
|
37
|
+
$ uffizzi compose list
|
|
37
38
|
|
|
38
|
-
To list all previews in a project with name my_project, run:
|
|
39
|
+
To list all compose environments (previews) in a project with name my_project, run:
|
|
39
40
|
|
|
40
|
-
$ uffizzi
|
|
41
|
+
$ uffizzi compose list \-\-project="my_project"
|
|
41
42
|
|
|
42
|
-
To list all previews in json format, run:
|
|
43
|
+
To list all compose environments (previews) in json format, run:
|
|
43
44
|
|
|
44
|
-
$ uffizzi
|
|
45
|
+
$ uffizzi compose list \-\-output="pretty\-json"
|
|
45
46
|
|
|
46
|
-
To list all previews filtered by metadata using single
|
|
47
|
+
To list all compose environments (previews) filtered by metadata using single
|
|
47
48
|
label, run:
|
|
48
49
|
|
|
49
|
-
$ uffizzi
|
|
50
|
+
$ uffizzi compose list \-\-filter github\.repo=my_repo
|
|
50
51
|
|
|
51
|
-
To list all previews filtered by metadata using multiple
|
|
52
|
+
To list all compose environments (previews) filtered by metadata using multiple
|
|
52
53
|
labels, run:
|
|
53
54
|
|
|
54
|
-
$ uffizzi
|
|
55
|
+
$ uffizzi compose list \e
|
|
55
56
|
\-\-filter="github\.repo=my_repo github\.pull_request\.number=23"
|
|
56
57
|
.fi
|
|
57
58
|
|
|
@@ -1,48 +1,49 @@
|
|
|
1
|
-
uffizzi-
|
|
1
|
+
uffizzi-compose-list - list compose environments (previews) in a project
|
|
2
2
|
================================================================
|
|
3
3
|
|
|
4
4
|
## SYNOPSIS
|
|
5
|
-
uffizzi
|
|
5
|
+
uffizzi compose list [UFFIZZI_WIDE_FLAG ...]
|
|
6
6
|
|
|
7
7
|
## DESCRIPTION
|
|
8
|
-
Lists all previews for a project,
|
|
9
|
-
deploying and failed
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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/
|
|
13
14
|
|
|
14
15
|
## FLAGS
|
|
15
16
|
--filter=METADATA
|
|
16
|
-
Metadata to
|
|
17
|
+
Metadata to filter list of deployments.
|
|
17
18
|
|
|
18
19
|
--output=pretty-json
|
|
19
20
|
Use this option for a more detailed description of listed
|
|
20
21
|
deployments.
|
|
21
22
|
|
|
22
23
|
## UFFIZZI WIDE FLAGS
|
|
23
|
-
These flags are available to all commands: --project. Run $ uffizzi
|
|
24
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
|
24
25
|
help for details.
|
|
25
26
|
|
|
26
27
|
## EXAMPLES
|
|
27
|
-
To list all previews in the default project, run:
|
|
28
|
+
To list all compose environments (previews) in the default project, run:
|
|
28
29
|
|
|
29
|
-
$ uffizzi
|
|
30
|
+
$ uffizzi compose list
|
|
30
31
|
|
|
31
|
-
To list all previews in a project with name my_project, run:
|
|
32
|
+
To list all compose environments (previews) in a project with name my_project, run:
|
|
32
33
|
|
|
33
|
-
$ uffizzi
|
|
34
|
+
$ uffizzi compose list --project="my_project"
|
|
34
35
|
|
|
35
|
-
To list all previews in json format, run:
|
|
36
|
+
To list all compose environments (previews) in json format, run:
|
|
36
37
|
|
|
37
|
-
$ uffizzi
|
|
38
|
+
$ uffizzi compose list --output="pretty-json"
|
|
38
39
|
|
|
39
|
-
To list all previews filtered by metadata using single
|
|
40
|
+
To list all compose environments (previews) filtered by metadata using single
|
|
40
41
|
label, run:
|
|
41
42
|
|
|
42
|
-
$ uffizzi
|
|
43
|
+
$ uffizzi compose list --filter github.repo=my_repo
|
|
43
44
|
|
|
44
|
-
To list all previews filtered by metadata using multiple
|
|
45
|
+
To list all compose environments (previews) filtered by metadata using multiple
|
|
45
46
|
labels, run:
|
|
46
47
|
|
|
47
|
-
$ uffizzi
|
|
48
|
-
--filter="github.repo=my_repo github.pull_request.number=23"
|
|
48
|
+
$ uffizzi compose list \
|
|
49
|
+
--filter="github.repo=my_repo github.pull_request.number=23"
|
|
@@ -1,27 +1,30 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
-
.TH "UFFIZZI\-PREVIEW\-SERVICE\-LIST" "" "
|
|
3
|
+
.TH "UFFIZZI\-PREVIEW\-SERVICE\-LIST" "" "August 2023" ""
|
|
4
4
|
.SH "NAME"
|
|
5
|
-
\fBuffizzi\-preview\-service\-list\fR
|
|
5
|
+
\fBuffizzi\-preview\-service\-list\fR
|
|
6
|
+
.P
|
|
7
|
+
uffizzi\-compose\-service\-list \- list the container services of a given compose environment (preview) ================================================================
|
|
6
8
|
.SH "SYNOPSIS"
|
|
7
9
|
.nf
|
|
8
|
-
uffizzi
|
|
10
|
+
uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
11
|
.fi
|
|
10
12
|
.SH "DESCRIPTION"
|
|
11
13
|
.nf
|
|
12
|
-
Shows a list of the container services that make up a given
|
|
13
|
-
deployment\.
|
|
14
|
+
Shows a list of the container services that make up a given
|
|
15
|
+
compose environment (preview) deployment\.
|
|
14
16
|
|
|
15
17
|
This command can fail for the following reasons:
|
|
16
|
-
\- There is no
|
|
18
|
+
\- There is no compose environment (preview)
|
|
19
|
+
with the given COMPOSE_ENVIRONMENT_ID
|
|
17
20
|
|
|
18
21
|
For more information on preview services, see:
|
|
19
|
-
https://
|
|
22
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
23
|
.fi
|
|
21
24
|
.SH "POSITIONAL ARGUMENTS"
|
|
22
25
|
.nf
|
|
23
|
-
[
|
|
24
|
-
The ID of the preview you want to list services for\.
|
|
26
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
27
|
+
The ID of the compose environment (preview) you want to list services for\.
|
|
25
28
|
.fi
|
|
26
29
|
.SH "UFFIZZI WIDE FLAGS"
|
|
27
30
|
.nf
|
|
@@ -30,9 +33,10 @@ help for details\.
|
|
|
30
33
|
.fi
|
|
31
34
|
.SH "EXAMPLES"
|
|
32
35
|
.nf
|
|
33
|
-
The following command lists the container services
|
|
34
|
-
|
|
36
|
+
The following command lists the container services
|
|
37
|
+
for a compose environment (preview) with
|
|
38
|
+
COMPOSE_ENVIRONMENT_ID deployment\-56:
|
|
35
39
|
|
|
36
|
-
$ uffizzi
|
|
40
|
+
$ uffizzi compose service list deployment\-56
|
|
37
41
|
.fi
|
|
38
42
|
|
|
@@ -1,29 +1,32 @@
|
|
|
1
|
-
uffizzi-
|
|
1
|
+
uffizzi-compose-service-list - list the container services
|
|
2
|
+
of a given compose environment (preview)
|
|
2
3
|
================================================================
|
|
3
4
|
|
|
4
5
|
## SYNOPSIS
|
|
5
|
-
uffizzi
|
|
6
|
+
uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
|
|
6
7
|
|
|
7
8
|
## DESCRIPTION
|
|
8
|
-
Shows a list of the container services that make up a given
|
|
9
|
-
deployment.
|
|
9
|
+
Shows a list of the container services that make up a given
|
|
10
|
+
compose environment (preview) deployment.
|
|
10
11
|
|
|
11
|
-
This command can fail for the following reasons:
|
|
12
|
-
- There is no
|
|
12
|
+
This command can fail for the following reasons:
|
|
13
|
+
- There is no compose environment (preview)
|
|
14
|
+
with the given COMPOSE_ENVIRONMENT_ID
|
|
13
15
|
|
|
14
16
|
For more information on preview services, see:
|
|
15
|
-
https://
|
|
17
|
+
https://docs.uffizzi.com/references/cli/
|
|
16
18
|
|
|
17
19
|
## POSITIONAL ARGUMENTS
|
|
18
|
-
[
|
|
19
|
-
The ID of the preview you want to list services for.
|
|
20
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
21
|
+
The ID of the compose environment (preview) you want to list services for.
|
|
20
22
|
|
|
21
23
|
## UFFIZZI WIDE FLAGS
|
|
22
|
-
These flags are available to all commands: --project. Run $ uffizzi
|
|
24
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
|
23
25
|
help for details.
|
|
24
26
|
|
|
25
27
|
## EXAMPLES
|
|
26
|
-
The following command lists the container services
|
|
27
|
-
|
|
28
|
+
The following command lists the container services
|
|
29
|
+
for a compose environment (preview) with
|
|
30
|
+
COMPOSE_ENVIRONMENT_ID deployment-56:
|
|
28
31
|
|
|
29
|
-
$ uffizzi
|
|
32
|
+
$ uffizzi compose service list deployment-56
|
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
-
.TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "
|
|
3
|
+
.TH "UFFIZZI\-PREVIEW\-SERVICE\-LOGS" "" "August 2023" ""
|
|
4
4
|
.SH "NAME"
|
|
5
|
-
\fBuffizzi\-preview\-service\-logs\fR
|
|
5
|
+
\fBuffizzi\-preview\-service\-logs\fR
|
|
6
|
+
.P
|
|
7
|
+
uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================
|
|
6
8
|
.SH "SYNOPSIS"
|
|
7
9
|
.nf
|
|
8
|
-
uffizzi
|
|
10
|
+
uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
11
|
.fi
|
|
10
12
|
.SH "DESCRIPTION"
|
|
11
13
|
.nf
|
|
12
|
-
Shows the logs for a given container service of a given preview\.
|
|
14
|
+
Shows the logs for a given container service of a given compose environment (preview)\.
|
|
13
15
|
|
|
14
16
|
This command can fail for the following reasons:
|
|
15
|
-
\- There is no preview with the given
|
|
17
|
+
\- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
|
16
18
|
\- There is no service with the name SERVICE
|
|
17
19
|
|
|
18
20
|
For more information on service logs, see:
|
|
19
|
-
https://
|
|
21
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
22
|
.fi
|
|
21
23
|
.SH "LOG_TYPE"
|
|
22
24
|
.nf
|
|
@@ -30,8 +32,8 @@ container
|
|
|
30
32
|
.fi
|
|
31
33
|
.SH "POSITIONAL ARGUMENTS"
|
|
32
34
|
.nf
|
|
33
|
-
[
|
|
34
|
-
The ID of the preview that includes the service you want to
|
|
35
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
36
|
+
The ID of the compose environment (preview) that includes the service you want to
|
|
35
37
|
show logs for\.
|
|
36
38
|
|
|
37
39
|
[SERVICE]
|
|
@@ -45,13 +47,13 @@ help for details\.
|
|
|
45
47
|
.SH "EXAMPLES"
|
|
46
48
|
.nf
|
|
47
49
|
The following command shows build logs for the service web\-app of the
|
|
48
|
-
preview with ID deployment\-14:
|
|
50
|
+
compose environment (preview) with ID deployment\-14:
|
|
49
51
|
|
|
50
|
-
$ uffizzi
|
|
52
|
+
$ uffizzi compose service logs build deployment\-14 web\-app
|
|
51
53
|
|
|
52
54
|
The following command shows container logs for the service postgres\-db of
|
|
53
|
-
the preview with ID deployment\-14:
|
|
55
|
+
the compose environment (preview) with ID deployment\-14:
|
|
54
56
|
|
|
55
|
-
$ uffizzi
|
|
57
|
+
$ uffizzi compose service logs container deployment\-14 postgres\-db
|
|
56
58
|
.fi
|
|
57
59
|
|
|
@@ -1,47 +1,48 @@
|
|
|
1
|
-
uffizzi-
|
|
1
|
+
uffizzi-compose-service-logs - show the logs for a container service
|
|
2
|
+
of a compose environment (preview)
|
|
2
3
|
================================================================
|
|
3
4
|
|
|
4
5
|
## SYNOPSIS
|
|
5
|
-
uffizzi
|
|
6
|
+
uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
|
|
6
7
|
|
|
7
8
|
## DESCRIPTION
|
|
8
|
-
Shows the logs for a given container service of a given preview.
|
|
9
|
+
Shows the logs for a given container service of a given compose environment (preview).
|
|
9
10
|
|
|
10
|
-
This command can fail for the following reasons:
|
|
11
|
-
- There is no preview with the given
|
|
11
|
+
This command can fail for the following reasons:
|
|
12
|
+
- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
|
12
13
|
- There is no service with the name SERVICE
|
|
13
14
|
|
|
14
15
|
For more information on service logs, see:
|
|
15
|
-
https://
|
|
16
|
+
https://docs.uffizzi.com/references/cli/
|
|
16
17
|
|
|
17
18
|
## LOG_TYPE
|
|
18
19
|
LOG_TYPE is one of the following:
|
|
19
|
-
|
|
20
|
+
|
|
20
21
|
build
|
|
21
22
|
The build logs of a service.
|
|
22
|
-
|
|
23
|
+
|
|
23
24
|
container
|
|
24
25
|
The container logs of a service.
|
|
25
26
|
|
|
26
27
|
## POSITIONAL ARGUMENTS
|
|
27
|
-
[
|
|
28
|
-
The ID of the preview that includes the service you want to
|
|
28
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
29
|
+
The ID of the compose environment (preview) that includes the service you want to
|
|
29
30
|
show logs for.
|
|
30
31
|
|
|
31
32
|
[SERVICE]
|
|
32
33
|
The name of the service you want to show logs for.
|
|
33
34
|
|
|
34
35
|
## UFFIZZI WIDE FLAGS
|
|
35
|
-
These flags are available to all commands: --project. Run $ uffizzi
|
|
36
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
|
36
37
|
help for details.
|
|
37
38
|
|
|
38
39
|
## EXAMPLES
|
|
39
|
-
The following command shows build logs for the service web-app of the
|
|
40
|
-
preview with ID deployment-14:
|
|
40
|
+
The following command shows build logs for the service web-app of the
|
|
41
|
+
compose environment (preview) with ID deployment-14:
|
|
41
42
|
|
|
42
|
-
$ uffizzi
|
|
43
|
+
$ uffizzi compose service logs build deployment-14 web-app
|
|
43
44
|
|
|
44
|
-
The following command shows container logs for the service postgres-db of
|
|
45
|
-
the preview with ID deployment-14:
|
|
45
|
+
The following command shows container logs for the service postgres-db of
|
|
46
|
+
the compose environment (preview) with ID deployment-14:
|
|
46
47
|
|
|
47
|
-
$ uffizzi
|
|
48
|
+
$ uffizzi compose service logs container deployment-14 postgres-db
|
data/man/uffizzi-preview-update
CHANGED
|
@@ -1,37 +1,38 @@
|
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
-
.TH "UPDATE" "" "August
|
|
3
|
+
.TH "UPDATE" "" "August 2023" ""
|
|
4
4
|
.SH "NAME"
|
|
5
|
-
\fBupdate\fR \- update a preview
|
|
5
|
+
\fBupdate\fR \- update a compose environment (preview)
|
|
6
6
|
.SH "SYNOPSIS"
|
|
7
7
|
.nf
|
|
8
|
-
uffizzi
|
|
8
|
+
uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
9
|
.fi
|
|
10
10
|
.SH "DESCRIPTION"
|
|
11
11
|
.nf
|
|
12
|
-
Given a preview ID and new compose file,
|
|
13
|
-
|
|
12
|
+
Given a compose environment (preview) ID and new compose file,
|
|
13
|
+
update a compose environment (preview)\. Updating a compose
|
|
14
|
+
environment (preview) does not change its compose environment (preview) URL\.
|
|
14
15
|
|
|
15
16
|
This command can fail for the following reasons:
|
|
16
|
-
\- There is no preview with the given
|
|
17
|
+
\- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
|
17
18
|
\- The COMPOSE_FILE specified is invalid
|
|
18
19
|
|
|
19
20
|
For more information on Uffizzi previews, see:
|
|
20
|
-
https://
|
|
21
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
21
22
|
.fi
|
|
22
23
|
.SH "POSITIONAL ARGUMENTS"
|
|
23
24
|
.nf
|
|
24
|
-
[
|
|
25
|
-
The ID of the preview that you want to update\.
|
|
25
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
26
|
+
The ID of the compose environment (preview) that you want to update\.
|
|
26
27
|
|
|
27
28
|
[COMPOSE_FILE]
|
|
28
|
-
The new compose file you want to preview\.
|
|
29
|
+
The new compose file you want to compose environment (preview)\.
|
|
29
30
|
.fi
|
|
30
31
|
.SH "FLAGS"
|
|
31
32
|
.nf
|
|
32
33
|
\-\-set\-labels=METADATA
|
|
33
34
|
Metadata of deployment that contains any information which can
|
|
34
|
-
be
|
|
35
|
+
be useful for filtering deployments\.
|
|
35
36
|
.fi
|
|
36
37
|
.SH "UFFIZZI WIDE FLAGS"
|
|
37
38
|
.nf
|
|
@@ -40,20 +41,20 @@ help for details\.
|
|
|
40
41
|
.fi
|
|
41
42
|
.SH "EXAMPLES"
|
|
42
43
|
.nf
|
|
43
|
-
The following command updates a
|
|
44
|
-
compose file docker\-compose\.alt\.yml:
|
|
44
|
+
The following command updates a compose environment (preview)
|
|
45
|
+
with ID deployment\-67 using compose file docker\-compose\.alt\.yml:
|
|
45
46
|
|
|
46
|
-
$ uffizzi
|
|
47
|
+
$ uffizzi compose update deployment\-67 docker\-compose\.alt\.yml
|
|
47
48
|
|
|
48
|
-
To update a
|
|
49
|
+
To update a compose with single label, run:
|
|
49
50
|
|
|
50
|
-
$ uffizzi
|
|
51
|
+
$ uffizzi compose update \e
|
|
51
52
|
deployment\-67 docker\-compose\.alt\.yml \e
|
|
52
53
|
\-\-set\-labels github\.repo=my_repo
|
|
53
54
|
|
|
54
|
-
To update a
|
|
55
|
+
To update a compose with multiple labels, run:
|
|
55
56
|
|
|
56
|
-
$ uffizzi
|
|
57
|
+
$ uffizzi compose update \e
|
|
57
58
|
deployment\-67 docker\-compose\.alt\.yml \e
|
|
58
59
|
\-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
|
|
59
60
|
.fi
|
|
@@ -1,50 +1,51 @@
|
|
|
1
|
-
uffizzi
|
|
1
|
+
uffizzi compose update - update a compose environment (preview)
|
|
2
2
|
================================================================
|
|
3
3
|
|
|
4
4
|
## SYNOPSIS
|
|
5
|
-
uffizzi
|
|
5
|
+
uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
|
|
6
6
|
|
|
7
7
|
## DESCRIPTION
|
|
8
|
-
Given a preview ID and new compose file,
|
|
9
|
-
|
|
8
|
+
Given a compose environment (preview) ID and new compose file,
|
|
9
|
+
update a compose environment (preview). Updating a compose
|
|
10
|
+
environment (preview) does not change its compose environment (preview) URL.
|
|
10
11
|
|
|
11
|
-
This command can fail for the following reasons:
|
|
12
|
-
- There is no preview with the given
|
|
12
|
+
This command can fail for the following reasons:
|
|
13
|
+
- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
|
13
14
|
- The COMPOSE_FILE specified is invalid
|
|
14
15
|
|
|
15
16
|
For more information on Uffizzi previews, see:
|
|
16
|
-
https://
|
|
17
|
+
https://docs.uffizzi.com/references/cli/
|
|
17
18
|
|
|
18
19
|
## POSITIONAL ARGUMENTS
|
|
19
|
-
[
|
|
20
|
-
The ID of the preview that you want to update.
|
|
20
|
+
[COMPOSE_ENVIRONMENT_ID]
|
|
21
|
+
The ID of the compose environment (preview) that you want to update.
|
|
21
22
|
|
|
22
23
|
[COMPOSE_FILE]
|
|
23
|
-
The new compose file you want to preview.
|
|
24
|
+
The new compose file you want to compose environment (preview).
|
|
24
25
|
|
|
25
26
|
## FLAGS
|
|
26
27
|
--set-labels=METADATA
|
|
27
28
|
Metadata of deployment that contains any information which can
|
|
28
|
-
be
|
|
29
|
+
be useful for filtering deployments.
|
|
29
30
|
|
|
30
31
|
## UFFIZZI WIDE FLAGS
|
|
31
|
-
These flags are available to all commands: --project. Run $ uffizzi
|
|
32
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
|
32
33
|
help for details.
|
|
33
34
|
|
|
34
35
|
## EXAMPLES
|
|
35
|
-
The following command updates a
|
|
36
|
-
compose file docker-compose.alt.yml:
|
|
36
|
+
The following command updates a compose environment (preview)
|
|
37
|
+
with ID deployment-67 using compose file docker-compose.alt.yml:
|
|
37
38
|
|
|
38
|
-
$ uffizzi
|
|
39
|
+
$ uffizzi compose update deployment-67 docker-compose.alt.yml
|
|
39
40
|
|
|
40
|
-
To update a
|
|
41
|
+
To update a compose with single label, run:
|
|
41
42
|
|
|
42
|
-
$ uffizzi
|
|
43
|
+
$ uffizzi compose update \
|
|
43
44
|
deployment-67 docker-compose.alt.yml \
|
|
44
45
|
--set-labels github.repo=my_repo
|
|
45
46
|
|
|
46
|
-
To update a
|
|
47
|
+
To update a compose with multiple labels, run:
|
|
47
48
|
|
|
48
|
-
$ uffizzi
|
|
49
|
+
$ uffizzi compose update \
|
|
49
50
|
deployment-67 docker-compose.alt.yml \
|
|
50
|
-
--set-labels="github.repo=my_repo github.pull_request.number=23"
|
|
51
|
+
--set-labels="github.repo=my_repo github.pull_request.number=23"
|
data/man/uffizzi-preview.ronn
CHANGED
|
@@ -1,33 +1,33 @@
|
|
|
1
|
-
uffizzi-
|
|
1
|
+
uffizzi-compose - manage previews
|
|
2
2
|
================================================================
|
|
3
3
|
|
|
4
4
|
## SYNOPSIS
|
|
5
|
-
uffizzi
|
|
5
|
+
uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG ...]
|
|
6
6
|
|
|
7
7
|
## DESCRIPTION
|
|
8
8
|
Manage Uffizzi previews
|
|
9
9
|
|
|
10
10
|
For more information on Uffizzi previews, see:
|
|
11
|
-
https://
|
|
11
|
+
https://docs.uffizzi.com/references/cli/
|
|
12
12
|
|
|
13
13
|
## UFFIZZI WIDE FLAGS
|
|
14
|
-
These flags are available to all commands: --project. Run $ uffizzi
|
|
14
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
|
15
15
|
help for details.
|
|
16
16
|
|
|
17
17
|
## COMMANDS
|
|
18
18
|
COMMAND is one of the following:
|
|
19
19
|
|
|
20
20
|
create
|
|
21
|
-
Create a preview
|
|
21
|
+
Create a compose environment (preview)
|
|
22
22
|
|
|
23
23
|
delete
|
|
24
|
-
Delete a preview
|
|
24
|
+
Delete a compose environment (preview)
|
|
25
25
|
|
|
26
26
|
describe
|
|
27
|
-
Display details of a preview
|
|
27
|
+
Display details of a compose environment (preview)
|
|
28
28
|
|
|
29
29
|
list
|
|
30
|
-
List all previews
|
|
30
|
+
List all compose environments (previews)
|
|
31
31
|
|
|
32
|
-
##
|
|
33
|
-
Run 'uffizzi
|
|
32
|
+
##
|
|
33
|
+
Run 'uffizzi compose COMMAND --help' for more information on a command.
|