uffizzi-cli 2.0.34 → 2.0.35
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/uffizzi/cli/common.rb +1 -1
- data/lib/uffizzi/version.rb +1 -1
- data/man/uffizzi +53 -0
- 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 +65 -0
- data/man/uffizzi-config.ronn +55 -0
- data/man/uffizzi-connect +40 -0
- data/man/uffizzi-connect-acr +37 -0
- data/man/uffizzi-connect-acr.ronn +42 -0
- data/man/uffizzi-connect-docker-hub +34 -0
- data/man/uffizzi-connect-docker-hub.ronn +39 -0
- data/man/uffizzi-connect-docker-registry +37 -0
- data/man/uffizzi-connect-docker-registry.ronn +41 -0
- data/man/uffizzi-connect-ecr +37 -0
- data/man/uffizzi-connect-ecr.ronn +42 -0
- data/man/uffizzi-connect-gcr +31 -0
- data/man/uffizzi-connect-gcr.ronn +36 -0
- data/man/uffizzi-connect-ghcr +34 -0
- data/man/uffizzi-connect-ghcr.ronn +40 -0
- data/man/uffizzi-connect.ronn +45 -0
- data/man/uffizzi-disconnect +37 -0
- data/man/uffizzi-disconnect.ronn +31 -0
- data/man/uffizzi-login +51 -0
- data/man/uffizzi-login-by-identity-token +29 -0
- data/man/uffizzi-login-by-identity-token.html +106 -0
- data/man/uffizzi-login-by-identity-token.ronn +21 -0
- data/man/uffizzi-login.html +113 -0
- data/man/uffizzi-login.ronn +41 -0
- data/man/uffizzi-logout +21 -0
- data/man/uffizzi-logout.ronn +19 -0
- data/man/uffizzi-preview +39 -0
- data/man/uffizzi-preview-create +67 -0
- data/man/uffizzi-preview-create.ronn +57 -0
- data/man/uffizzi-preview-delete +38 -0
- data/man/uffizzi-preview-delete.ronn +29 -0
- data/man/uffizzi-preview-describe +38 -0
- data/man/uffizzi-preview-describe.ronn +29 -0
- data/man/uffizzi-preview-events +38 -0
- data/man/uffizzi-preview-events.ronn +29 -0
- data/man/uffizzi-preview-list +58 -0
- data/man/uffizzi-preview-list.ronn +49 -0
- data/man/uffizzi-preview-service-list +42 -0
- data/man/uffizzi-preview-service-list.ronn +32 -0
- data/man/uffizzi-preview-service-logs +59 -0
- data/man/uffizzi-preview-service-logs.ronn +48 -0
- data/man/uffizzi-preview-update +61 -0
- data/man/uffizzi-preview-update.ronn +51 -0
- data/man/uffizzi-preview.ronn +33 -0
- data/man/uffizzi-preview_service_logs +59 -0
- data/man/uffizzi-preview_service_logs.ronn +50 -0
- data/man/uffizzi-project +47 -0
- data/man/uffizzi-project-compose +40 -0
- data/man/uffizzi-project-compose-describe +37 -0
- data/man/uffizzi-project-compose-describe.ronn +29 -0
- data/man/uffizzi-project-compose-set +66 -0
- data/man/uffizzi-project-compose-set.ronn +57 -0
- data/man/uffizzi-project-compose-unset +35 -0
- data/man/uffizzi-project-compose-unset.ronn +27 -0
- data/man/uffizzi-project-compose.ronn +34 -0
- data/man/uffizzi-project-create +50 -0
- data/man/uffizzi-project-create.ronn +41 -0
- data/man/uffizzi-project-delete +32 -0
- data/man/uffizzi-project-delete.ronn +24 -0
- data/man/uffizzi-project-describe +43 -0
- data/man/uffizzi-project-describe.ronn +34 -0
- 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 +37 -0
- data/man/uffizzi-project-secret-create +29 -0
- data/man/uffizzi-project-secret-create.ronn +21 -0
- data/man/uffizzi-project-secret-delete +29 -0
- data/man/uffizzi-project-secret-delete.ronn +21 -0
- data/man/uffizzi-project-secret-list +28 -0
- data/man/uffizzi-project-secret-list.ronn +20 -0
- data/man/uffizzi-project-secret.ronn +30 -0
- data/man/uffizzi-project-set-default +34 -0
- data/man/uffizzi-project-set-default.ronn +26 -0
- data/man/uffizzi-project.html +124 -0
- data/man/uffizzi-project.ronn +41 -0
- data/man/uffizzi.html +132 -0
- data/man/uffizzi.ronn +45 -0
- metadata +122 -1
@@ -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
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
uffizzi-compose-service-list - list the container services
|
2
|
+
of a given compose environment (preview)
|
3
|
+
================================================================
|
4
|
+
|
5
|
+
## SYNOPSIS
|
6
|
+
uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
|
7
|
+
|
8
|
+
## DESCRIPTION
|
9
|
+
Shows a list of the container services that make up a given
|
10
|
+
compose environment (preview) deployment.
|
11
|
+
|
12
|
+
This command can fail for the following reasons:
|
13
|
+
- There is no compose environment (preview)
|
14
|
+
with the given COMPOSE_ENVIRONMENT_ID
|
15
|
+
|
16
|
+
For more information on preview services, see:
|
17
|
+
https://docs.uffizzi.com/references/cli/
|
18
|
+
|
19
|
+
## POSITIONAL ARGUMENTS
|
20
|
+
[COMPOSE_ENVIRONMENT_ID]
|
21
|
+
The ID of the compose environment (preview) you want to list services for.
|
22
|
+
|
23
|
+
## UFFIZZI WIDE FLAGS
|
24
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
25
|
+
help for details.
|
26
|
+
|
27
|
+
## EXAMPLES
|
28
|
+
The following command lists the container services
|
29
|
+
for a compose environment (preview) with
|
30
|
+
COMPOSE_ENVIRONMENT_ID deployment-56:
|
31
|
+
|
32
|
+
$ uffizzi compose service list deployment-56
|
@@ -0,0 +1,59 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE\-SERVICE\-LOGS" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose\-service\-logs\fR
|
6
|
+
.P
|
7
|
+
uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================
|
8
|
+
.SH "SYNOPSIS"
|
9
|
+
.nf
|
10
|
+
uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
11
|
+
.fi
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
.nf
|
14
|
+
Shows the logs for a given container service of a given compose environment (preview)\.
|
15
|
+
|
16
|
+
This command can fail for the following reasons:
|
17
|
+
\- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
18
|
+
\- There is no service with the name SERVICE
|
19
|
+
|
20
|
+
For more information on service logs, see:
|
21
|
+
https://docs\.uffizzi\.com/references/cli/
|
22
|
+
.fi
|
23
|
+
.SH "LOG_TYPE"
|
24
|
+
.nf
|
25
|
+
LOG_TYPE is one of the following:
|
26
|
+
|
27
|
+
build
|
28
|
+
The build logs of a service\.
|
29
|
+
|
30
|
+
container
|
31
|
+
The container logs of a service\.
|
32
|
+
.fi
|
33
|
+
.SH "POSITIONAL ARGUMENTS"
|
34
|
+
.nf
|
35
|
+
[COMPOSE_ENVIRONMENT_ID]
|
36
|
+
The ID of the compose environment (preview) that includes the service you want to
|
37
|
+
show logs for\.
|
38
|
+
|
39
|
+
[SERVICE]
|
40
|
+
The name of the service you want to show logs for\.
|
41
|
+
.fi
|
42
|
+
.SH "UFFIZZI WIDE FLAGS"
|
43
|
+
.nf
|
44
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
45
|
+
help for details\.
|
46
|
+
.fi
|
47
|
+
.SH "EXAMPLES"
|
48
|
+
.nf
|
49
|
+
The following command shows build logs for the service web\-app of the
|
50
|
+
compose environment (preview) with ID deployment\-14:
|
51
|
+
|
52
|
+
$ uffizzi compose service logs build deployment\-14 web\-app
|
53
|
+
|
54
|
+
The following command shows container logs for the service postgres\-db of
|
55
|
+
the compose environment (preview) with ID deployment\-14:
|
56
|
+
|
57
|
+
$ uffizzi compose service logs container deployment\-14 postgres\-db
|
58
|
+
.fi
|
59
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
uffizzi-compose-service-logs - show the logs for a container service
|
2
|
+
of a compose environment (preview)
|
3
|
+
================================================================
|
4
|
+
|
5
|
+
## SYNOPSIS
|
6
|
+
uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
|
7
|
+
|
8
|
+
## DESCRIPTION
|
9
|
+
Shows the logs for a given container service of a given compose environment (preview).
|
10
|
+
|
11
|
+
This command can fail for the following reasons:
|
12
|
+
- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
13
|
+
- There is no service with the name SERVICE
|
14
|
+
|
15
|
+
For more information on service logs, see:
|
16
|
+
https://docs.uffizzi.com/references/cli/
|
17
|
+
|
18
|
+
## LOG_TYPE
|
19
|
+
LOG_TYPE is one of the following:
|
20
|
+
|
21
|
+
build
|
22
|
+
The build logs of a service.
|
23
|
+
|
24
|
+
container
|
25
|
+
The container logs of a service.
|
26
|
+
|
27
|
+
## POSITIONAL ARGUMENTS
|
28
|
+
[COMPOSE_ENVIRONMENT_ID]
|
29
|
+
The ID of the compose environment (preview) that includes the service you want to
|
30
|
+
show logs for.
|
31
|
+
|
32
|
+
[SERVICE]
|
33
|
+
The name of the service you want to show logs for.
|
34
|
+
|
35
|
+
## UFFIZZI WIDE FLAGS
|
36
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
37
|
+
help for details.
|
38
|
+
|
39
|
+
## EXAMPLES
|
40
|
+
The following command shows build logs for the service web-app of the
|
41
|
+
compose environment (preview) with ID deployment-14:
|
42
|
+
|
43
|
+
$ uffizzi compose service logs build deployment-14 web-app
|
44
|
+
|
45
|
+
The following command shows container logs for the service postgres-db of
|
46
|
+
the compose environment (preview) with ID deployment-14:
|
47
|
+
|
48
|
+
$ uffizzi compose service logs container deployment-14 postgres-db
|
@@ -0,0 +1,61 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UPDATE" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBupdate\fR \- update a compose environment (preview)
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
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\.
|
15
|
+
|
16
|
+
This command can fail for the following reasons:
|
17
|
+
\- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
18
|
+
\- The COMPOSE_FILE specified is invalid
|
19
|
+
|
20
|
+
For more information on Uffizzi previews, see:
|
21
|
+
https://docs\.uffizzi\.com/references/cli/
|
22
|
+
.fi
|
23
|
+
.SH "POSITIONAL ARGUMENTS"
|
24
|
+
.nf
|
25
|
+
[COMPOSE_ENVIRONMENT_ID]
|
26
|
+
The ID of the compose environment (preview) that you want to update\.
|
27
|
+
|
28
|
+
[COMPOSE_FILE]
|
29
|
+
The new compose file you want to compose environment (preview)\.
|
30
|
+
.fi
|
31
|
+
.SH "FLAGS"
|
32
|
+
.nf
|
33
|
+
\-\-set\-labels=METADATA
|
34
|
+
Metadata of deployment that contains any information which can
|
35
|
+
be useful for filtering deployments\.
|
36
|
+
.fi
|
37
|
+
.SH "UFFIZZI WIDE FLAGS"
|
38
|
+
.nf
|
39
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
40
|
+
help for details\.
|
41
|
+
.fi
|
42
|
+
.SH "EXAMPLES"
|
43
|
+
.nf
|
44
|
+
The following command updates a compose environment (preview)
|
45
|
+
with ID deployment\-67 using compose file docker\-compose\.alt\.yml:
|
46
|
+
|
47
|
+
$ uffizzi compose update deployment\-67 docker\-compose\.alt\.yml
|
48
|
+
|
49
|
+
To update a compose with single label, run:
|
50
|
+
|
51
|
+
$ uffizzi compose update \e
|
52
|
+
deployment\-67 docker\-compose\.alt\.yml \e
|
53
|
+
\-\-set\-labels github\.repo=my_repo
|
54
|
+
|
55
|
+
To update a compose with multiple labels, run:
|
56
|
+
|
57
|
+
$ uffizzi compose update \e
|
58
|
+
deployment\-67 docker\-compose\.alt\.yml \e
|
59
|
+
\-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
|
60
|
+
.fi
|
61
|
+
|
@@ -0,0 +1,51 @@
|
|
1
|
+
uffizzi compose update - update a compose environment (preview)
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
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.
|
11
|
+
|
12
|
+
This command can fail for the following reasons:
|
13
|
+
- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
14
|
+
- The COMPOSE_FILE specified is invalid
|
15
|
+
|
16
|
+
For more information on Uffizzi previews, see:
|
17
|
+
https://docs.uffizzi.com/references/cli/
|
18
|
+
|
19
|
+
## POSITIONAL ARGUMENTS
|
20
|
+
[COMPOSE_ENVIRONMENT_ID]
|
21
|
+
The ID of the compose environment (preview) that you want to update.
|
22
|
+
|
23
|
+
[COMPOSE_FILE]
|
24
|
+
The new compose file you want to compose environment (preview).
|
25
|
+
|
26
|
+
## FLAGS
|
27
|
+
--set-labels=METADATA
|
28
|
+
Metadata of deployment that contains any information which can
|
29
|
+
be useful for filtering deployments.
|
30
|
+
|
31
|
+
## UFFIZZI WIDE FLAGS
|
32
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
33
|
+
help for details.
|
34
|
+
|
35
|
+
## EXAMPLES
|
36
|
+
The following command updates a compose environment (preview)
|
37
|
+
with ID deployment-67 using compose file docker-compose.alt.yml:
|
38
|
+
|
39
|
+
$ uffizzi compose update deployment-67 docker-compose.alt.yml
|
40
|
+
|
41
|
+
To update a compose with single label, run:
|
42
|
+
|
43
|
+
$ uffizzi compose update \
|
44
|
+
deployment-67 docker-compose.alt.yml \
|
45
|
+
--set-labels github.repo=my_repo
|
46
|
+
|
47
|
+
To update a compose with multiple labels, run:
|
48
|
+
|
49
|
+
$ uffizzi compose update \
|
50
|
+
deployment-67 docker-compose.alt.yml \
|
51
|
+
--set-labels="github.repo=my_repo github.pull_request.number=23"
|
@@ -0,0 +1,33 @@
|
|
1
|
+
uffizzi-compose - manage previews
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
Manage Uffizzi previews
|
9
|
+
|
10
|
+
For more information on Uffizzi previews, see:
|
11
|
+
https://docs.uffizzi.com/references/cli/
|
12
|
+
|
13
|
+
## UFFIZZI WIDE FLAGS
|
14
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
15
|
+
help for details.
|
16
|
+
|
17
|
+
## COMMANDS
|
18
|
+
COMMAND is one of the following:
|
19
|
+
|
20
|
+
create
|
21
|
+
Create a compose environment (preview)
|
22
|
+
|
23
|
+
delete
|
24
|
+
Delete a compose environment (preview)
|
25
|
+
|
26
|
+
describe
|
27
|
+
Display details of a compose environment (preview)
|
28
|
+
|
29
|
+
list
|
30
|
+
List all compose environments (previews)
|
31
|
+
|
32
|
+
##
|
33
|
+
Run 'uffizzi compose COMMAND --help' for more information on a command.
|
@@ -0,0 +1,59 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-COMPOSE_SERVICE_LOGS" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-compose_service_logs\fR
|
6
|
+
.P
|
7
|
+
uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================
|
8
|
+
.SH "SYNOPSIS"
|
9
|
+
.nf
|
10
|
+
uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
11
|
+
.fi
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
.nf
|
14
|
+
Shows the logs for a given container service of a given compose environment (preview)\.
|
15
|
+
|
16
|
+
This command can fail for the following reasons:
|
17
|
+
\- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
18
|
+
\- There is no service with the name SERVICE
|
19
|
+
|
20
|
+
For more information on service logs, see:
|
21
|
+
https://docs\.uffizzi\.com/references/cli/
|
22
|
+
.fi
|
23
|
+
.SH "LOG_TYPE"
|
24
|
+
.nf
|
25
|
+
LOG_TYPE is one of the following:
|
26
|
+
|
27
|
+
build
|
28
|
+
The build logs of a service\.
|
29
|
+
|
30
|
+
container
|
31
|
+
The container logs of a service\.
|
32
|
+
.fi
|
33
|
+
.SH "POSITIONAL ARGUMENTS"
|
34
|
+
.nf
|
35
|
+
[COMPOSE_ENVIRONMENT_ID]
|
36
|
+
The ID of the compose environment (preview) that includes the service you want to
|
37
|
+
show logs for\.
|
38
|
+
|
39
|
+
[SERVICE]
|
40
|
+
The name of the service you want to show logs for\.
|
41
|
+
.fi
|
42
|
+
.SH "UFFIZZI WIDE FLAGS"
|
43
|
+
.nf
|
44
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
45
|
+
help for details\.
|
46
|
+
.fi
|
47
|
+
.SH "EXAMPLES"
|
48
|
+
.nf
|
49
|
+
The following command shows build logs for the service web\-app of the
|
50
|
+
compose environment (preview) with ID deployment\-14:
|
51
|
+
|
52
|
+
$ uffizzi compose service logs build deployment\-14 web\-app
|
53
|
+
|
54
|
+
The following command shows container logs for the service postgres\-db of
|
55
|
+
the compose environment (preview) with ID deployment\-14:
|
56
|
+
|
57
|
+
$ uffizzi compose service logs container deployment\-14 postgres\-db
|
58
|
+
.fi
|
59
|
+
|
@@ -0,0 +1,50 @@
|
|
1
|
+
uffizzi-compose-service-logs - show the logs for a container service
|
2
|
+
of a compose environment (preview)
|
3
|
+
================================================================
|
4
|
+
|
5
|
+
## SYNOPSIS
|
6
|
+
uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
|
7
|
+
|
8
|
+
## DESCRIPTION
|
9
|
+
Shows the logs for a given container service of a given compose environment (preview).
|
10
|
+
|
11
|
+
This command can fail for the following reasons:
|
12
|
+
- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
|
13
|
+
- There is no service with the name SERVICE
|
14
|
+
|
15
|
+
For more information on service logs, see:
|
16
|
+
https://docs.uffizzi.com/references/cli/
|
17
|
+
|
18
|
+
## LOG_TYPE
|
19
|
+
LOG_TYPE is one of the following:
|
20
|
+
|
21
|
+
build
|
22
|
+
The build logs of a service.
|
23
|
+
|
24
|
+
container
|
25
|
+
The container logs of a service.
|
26
|
+
|
27
|
+
## POSITIONAL ARGUMENTS
|
28
|
+
[COMPOSE_ENVIRONMENT_ID]
|
29
|
+
The ID of the compose environment (preview) that includes the service you want to
|
30
|
+
show logs for.
|
31
|
+
|
32
|
+
[SERVICE]
|
33
|
+
The name of the service you want to show logs for.
|
34
|
+
|
35
|
+
|
36
|
+
## UFFIZZI WIDE FLAGS
|
37
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
38
|
+
help for details.
|
39
|
+
|
40
|
+
## EXAMPLES
|
41
|
+
The following command shows build logs for the service web-app of the
|
42
|
+
compose environment (preview) with ID deployment-14:
|
43
|
+
|
44
|
+
$ uffizzi compose service logs build deployment-14 web-app
|
45
|
+
|
46
|
+
The following command shows container logs for the service postgres-db of
|
47
|
+
the compose environment (preview) with ID deployment-14:
|
48
|
+
|
49
|
+
$ uffizzi compose service logs container deployment-14 postgres-db
|
50
|
+
|
data/man/uffizzi-config
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "CONFIG" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBconfig\fR \- configure the Uffizzi command\-line interface (CLI)
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi config COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
The uffizzi config command lets you configure this command\-line application\.
|
13
|
+
If COMMAND is not specified, uffizzi config launches an interactive set up
|
14
|
+
guide\.
|
15
|
+
|
16
|
+
For more information on configuration options, see:
|
17
|
+
https://docs\.uffizzi\.com/references/cli/
|
18
|
+
.fi
|
19
|
+
.SH "UFFIZZI WIDE FLAGS"
|
20
|
+
.nf
|
21
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
22
|
+
help for details\.
|
23
|
+
.fi
|
24
|
+
.SH "COMMANDS"
|
25
|
+
.nf
|
26
|
+
COMMAND is one of the following:
|
27
|
+
|
28
|
+
get\-value OPTION
|
29
|
+
Displays the value of the specified option\.
|
30
|
+
|
31
|
+
list
|
32
|
+
Lists all options and their values from the config file\.
|
33
|
+
|
34
|
+
set OPTION VALUE
|
35
|
+
Sets the value of the specified option\.
|
36
|
+
|
37
|
+
unset OPTION
|
38
|
+
Deletes the value of the specified option\.
|
39
|
+
.fi
|
40
|
+
.SH "OPTIONS"
|
41
|
+
.nf
|
42
|
+
OPTION is one of the following:
|
43
|
+
|
44
|
+
server
|
45
|
+
The server of the Uffizzi API service you want to access\. Defaults to
|
46
|
+
app\.uffizzi\.com\.
|
47
|
+
|
48
|
+
name
|
49
|
+
Your name\.
|
50
|
+
|
51
|
+
project
|
52
|
+
The current active project\. This project is used as the default unless
|
53
|
+
\-\-project is pass as an argument\.
|
54
|
+
.fi
|
55
|
+
.SH "EXAMPLES"
|
56
|
+
.nf
|
57
|
+
To list the uffizzi configuration options, run:
|
58
|
+
|
59
|
+
$ uffizzi config list
|
60
|
+
|
61
|
+
To set a new current active project for uffizzi, run:
|
62
|
+
|
63
|
+
$ uffizzi config set project my\-project
|
64
|
+
.fi
|
65
|
+
|
@@ -0,0 +1,55 @@
|
|
1
|
+
uffizzi config - configure the Uffizzi command-line interface (CLI)
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi config COMMAND [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
The uffizzi config command lets you configure this command-line application.
|
9
|
+
If COMMAND is not specified, uffizzi config launches an interactive set up
|
10
|
+
guide.
|
11
|
+
|
12
|
+
For more information on configuration options, see:
|
13
|
+
https://docs.uffizzi.com/references/cli/
|
14
|
+
|
15
|
+
## UFFIZZI WIDE FLAGS
|
16
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
17
|
+
help for details.
|
18
|
+
|
19
|
+
## COMMANDS
|
20
|
+
COMMAND is one of the following:
|
21
|
+
|
22
|
+
get-value OPTION
|
23
|
+
Displays the value of the specified option.
|
24
|
+
|
25
|
+
list
|
26
|
+
Lists all options and their values from the config file.
|
27
|
+
|
28
|
+
set OPTION VALUE
|
29
|
+
Sets the value of the specified option.
|
30
|
+
|
31
|
+
unset OPTION
|
32
|
+
Deletes the value of the specified option.
|
33
|
+
|
34
|
+
## OPTIONS
|
35
|
+
OPTION is one of the following:
|
36
|
+
|
37
|
+
server
|
38
|
+
The server of the Uffizzi API service you want to access. Defaults to
|
39
|
+
app.uffizzi.com.
|
40
|
+
|
41
|
+
name
|
42
|
+
Your name.
|
43
|
+
|
44
|
+
project
|
45
|
+
The current active project. This project is used as the default unless
|
46
|
+
--project is pass as an argument.
|
47
|
+
|
48
|
+
## EXAMPLES
|
49
|
+
To list the uffizzi configuration options, run:
|
50
|
+
|
51
|
+
$ uffizzi config list
|
52
|
+
|
53
|
+
To set a new current active project for uffizzi, run:
|
54
|
+
|
55
|
+
$ uffizzi config set project my-project
|