uffizzi-cli 2.0.34 → 2.0.35
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/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
data/man/uffizzi-connect
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
+
.TH "UFFIZZI\-CONNECT" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-connect\fR \- grant a Uffizzi user account access to external services
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBuffizzi connect\fR COMMAND [\-\-skip\-raise\-existence\-error] [\-\-update\-credential\-if\-exists]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Grants a Uffizzi user account access to external services\.
|
|
10
|
+
.P
|
|
11
|
+
For more information on connecting to external services, see: https://docs\.uffizzi\.com/references/cli/
|
|
12
|
+
.SH "COMMANDS"
|
|
13
|
+
COMMAND is one of the following:
|
|
14
|
+
.TP
|
|
15
|
+
\fBacr\fR
|
|
16
|
+
Connect to Azure Container Registry (azurecr\.io)\.
|
|
17
|
+
.TP
|
|
18
|
+
\fBdocker\-hub\fR
|
|
19
|
+
Connect to Docker Hub (hub\.docker\.com)\.
|
|
20
|
+
.TP
|
|
21
|
+
\fBdocker\-registry\fR
|
|
22
|
+
Connect to any registry implementing the Docker Registry HTTP API protocol
|
|
23
|
+
.TP
|
|
24
|
+
\fBecr\fR
|
|
25
|
+
Connect to Amazon Elastic Container Registry (amazonaws\.com)\.
|
|
26
|
+
.TP
|
|
27
|
+
\fBgcr\fR
|
|
28
|
+
Connect to Google Container Registry (gcr\.io)\.
|
|
29
|
+
.TP
|
|
30
|
+
\fBghcr\fR
|
|
31
|
+
Connect to GitHub Container Registry (ghcr\.io)\.
|
|
32
|
+
.SH "FLAGS"
|
|
33
|
+
.TP
|
|
34
|
+
\fB\-\-skip\-raise\-existence\-error\fR
|
|
35
|
+
If credential exists, do not raise an exception, just print a message\.
|
|
36
|
+
.TP
|
|
37
|
+
\fB\-\-update\-credential\-if\-exists\fR
|
|
38
|
+
Update credential if it exists\.
|
|
39
|
+
.P
|
|
40
|
+
Run \fBuffizzi connect COMMAND \-\-help\fR for more information on a command\.
|
|
@@ -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\-CONNECT\-ACR" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-connect\-acr\fR \- grant a Uffizzi user account access to a private Azure Container Registry (ACR)
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBuffizzi connect acr\fR [\-\-registry=REGISTRY] [\-\-username=USERNAME] [\-\-password=PASSWORD]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access to a private Azure Container Registry
|
|
10
|
+
.P
|
|
11
|
+
Credentials can be provided interactively or non\-interactively via command options or environment variables:
|
|
12
|
+
.br
|
|
13
|
+
\fBACR_REGISTRY_URL\fR, \fBACR_REGISTRY_USERNAME\fR, \fBACR_REGISTRY_PASSWORD\fR
|
|
14
|
+
.P
|
|
15
|
+
This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
|
|
16
|
+
.P
|
|
17
|
+
For more information on connecting to external services, see:
|
|
18
|
+
.br
|
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
|
+
.P
|
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
|
22
|
+
.br
|
|
23
|
+
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
|
24
|
+
.SH "OPTIONS"
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-r\fR, \fB\-\-registry=<registry>\fR
|
|
27
|
+
URL of the service\.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-u\fR, \fB\-\-username=<username>\fR
|
|
30
|
+
Username for the service\.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-p\fR, \fB\-\-password=<password>\fR
|
|
33
|
+
Password for the service\.
|
|
34
|
+
.SH "EXAMPLES"
|
|
35
|
+
The following command will prompt the user to enter ACR credentials, including registry domain, Docker ID and password or access token:
|
|
36
|
+
.P
|
|
37
|
+
\fBuffizzi connect acr\fR
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# uffizzi-connect-acr - grant a Uffizzi user account access to a private Azure Container Registry (ACR)
|
|
2
|
+
|
|
3
|
+
## SYNOPSIS
|
|
4
|
+
|
|
5
|
+
`uffizzi connect acr` [--registry=REGISTRY] [--username=USERNAME] [--password=PASSWORD]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access
|
|
10
|
+
to a private Azure Container Registry
|
|
11
|
+
|
|
12
|
+
Credentials can be provided interactively or non-interactively
|
|
13
|
+
via command options or environment variables:
|
|
14
|
+
`ACR_REGISTRY_URL`, `ACR_REGISTRY_USERNAME`, `ACR_REGISTRY_PASSWORD`
|
|
15
|
+
|
|
16
|
+
This command can fail for the following reasons:
|
|
17
|
+
- The active user does not have permission to connect external services.
|
|
18
|
+
- The given credentials are invalid.
|
|
19
|
+
|
|
20
|
+
For more information on connecting to external services, see:
|
|
21
|
+
https://docs.uffizzi.com/references/cli/
|
|
22
|
+
|
|
23
|
+
For detailed instructions on configuring webhooks to send push
|
|
24
|
+
notifications to Uffizzi, see:
|
|
25
|
+
https://docs.uffizzi.com/guides/container-registry-integrations
|
|
26
|
+
|
|
27
|
+
## OPTIONS
|
|
28
|
+
|
|
29
|
+
* `-r`, `--registry=<registry>`:
|
|
30
|
+
URL of the service.
|
|
31
|
+
* `-u`, `--username=<username>`:
|
|
32
|
+
Username for the service.
|
|
33
|
+
* `-p`, `--password=<password>`:
|
|
34
|
+
Password for the service.
|
|
35
|
+
|
|
36
|
+
## EXAMPLES
|
|
37
|
+
|
|
38
|
+
The following command will prompt the user to enter ACR
|
|
39
|
+
credentials, including registry domain, Docker ID and
|
|
40
|
+
password or access token:
|
|
41
|
+
|
|
42
|
+
`uffizzi connect acr`
|
|
@@ -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\-CONNECT\-DOCKER\-HUB" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-connect\-docker\-hub\fR \- grant a Uffizzi user account access to a private Docker Hub registry\.
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBuffizzi connect docker\-hub\fR [\-\-username=USERNAME] [\-\-password=PASSWORD]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access to a private Docker Hub registry
|
|
10
|
+
.P
|
|
11
|
+
Credentials can be provided interactively or non\-interactively via command options or environment variables:
|
|
12
|
+
.br
|
|
13
|
+
\fBDOCKERHUB_USERNAME\fR, \fBDOCKERHUB_PASSWORD\fR
|
|
14
|
+
.P
|
|
15
|
+
This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
|
|
16
|
+
.P
|
|
17
|
+
For more information on connecting to external services, see:
|
|
18
|
+
.br
|
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
|
+
.P
|
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
|
22
|
+
.br
|
|
23
|
+
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
|
24
|
+
.SH "OPTIONS"
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-u\fR, \fB\-\-username=<username>\fR
|
|
27
|
+
Username for the service\.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-p\fR, \fB\-\-password=<password>\fR
|
|
30
|
+
Password for the service\.
|
|
31
|
+
.SH "EXAMPLES"
|
|
32
|
+
The following command will prompt the user to enter Docker Hub credentials, including Docker ID and password or access token:
|
|
33
|
+
.P
|
|
34
|
+
\fBuffizzi connect docker\-hub\fR
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# uffizzi-connect-docker-hub - grant a Uffizzi user account access to a private Docker Hub registry.
|
|
2
|
+
|
|
3
|
+
## SYNOPSIS
|
|
4
|
+
|
|
5
|
+
`uffizzi connect docker-hub` [--username=USERNAME] [--password=PASSWORD]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access
|
|
10
|
+
to a private Docker Hub registry
|
|
11
|
+
|
|
12
|
+
Credentials can be provided interactively or non-interactively
|
|
13
|
+
via command options or environment variables:
|
|
14
|
+
`DOCKERHUB_USERNAME`, `DOCKERHUB_PASSWORD`
|
|
15
|
+
|
|
16
|
+
This command can fail for the following reasons:
|
|
17
|
+
- The active user does not have permission to connect external services.
|
|
18
|
+
- The given credentials are invalid.
|
|
19
|
+
|
|
20
|
+
For more information on connecting to external services, see:
|
|
21
|
+
https://docs.uffizzi.com/references/cli/
|
|
22
|
+
|
|
23
|
+
For detailed instructions on configuring webhooks to send push
|
|
24
|
+
notifications to Uffizzi, see:
|
|
25
|
+
https://docs.uffizzi.com/guides/container-registry-integrations
|
|
26
|
+
|
|
27
|
+
## OPTIONS
|
|
28
|
+
|
|
29
|
+
* `-u`, `--username=<username>`:
|
|
30
|
+
Username for the service.
|
|
31
|
+
* `-p`, `--password=<password>`:
|
|
32
|
+
Password for the service.
|
|
33
|
+
|
|
34
|
+
## EXAMPLES
|
|
35
|
+
|
|
36
|
+
The following command will prompt the user to enter Docker Hub
|
|
37
|
+
credentials, including Docker ID and password or access token:
|
|
38
|
+
|
|
39
|
+
`uffizzi connect docker-hub`
|
|
@@ -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\-CONNECT\-DOCKER\-REGISTRY" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-connect\-docker\-registry\fR \- grant a Uffizzi user account access to a Docker Container Registry\.
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBuffizzi connect docker\-registry\fR [\-\-registry=REGISTRY] [\-\-username=USERNAME] [\-\-password=PASSWORD]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access to a Docker Container Registry
|
|
10
|
+
.P
|
|
11
|
+
Credentials can be provided interactively or non\-interactively via command options or environment variables:
|
|
12
|
+
.br
|
|
13
|
+
\fBDOCKER_REGISTRY_URL\fR, \fBDOCKER_REGISTRY_USERNAME\fR, \fBDOCKER_REGISTRY_PASSWORD\fR
|
|
14
|
+
.P
|
|
15
|
+
This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
|
|
16
|
+
.P
|
|
17
|
+
For more information on connecting to external services, see:
|
|
18
|
+
.br
|
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
|
+
.P
|
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
|
22
|
+
.br
|
|
23
|
+
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
|
24
|
+
.SH "OPTIONS"
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-r\fR, \fB\-\-registry=<registry>\fR
|
|
27
|
+
URL of the service\.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-u\fR, \fB\-\-username=<username>\fR
|
|
30
|
+
Username for the service\.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-p\fR, \fB\-\-password=<password>\fR
|
|
33
|
+
Password for the service\.
|
|
34
|
+
.SH "EXAMPLES"
|
|
35
|
+
The following command will prompt the user to enter Docker Container Registry credentials, including username and password:
|
|
36
|
+
.P
|
|
37
|
+
\fBuffizzi connect docker\-registry\fR
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# uffizzi-connect-docker-registry - grant a Uffizzi user account access to a Docker Container Registry.
|
|
2
|
+
|
|
3
|
+
## SYNOPSIS
|
|
4
|
+
|
|
5
|
+
`uffizzi connect docker-registry` [--registry=REGISTRY] [--username=USERNAME] [--password=PASSWORD]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access
|
|
10
|
+
to a Docker Container Registry
|
|
11
|
+
|
|
12
|
+
Credentials can be provided interactively or non-interactively
|
|
13
|
+
via command options or environment variables:
|
|
14
|
+
`DOCKER_REGISTRY_URL`, `DOCKER_REGISTRY_USERNAME`, `DOCKER_REGISTRY_PASSWORD`
|
|
15
|
+
|
|
16
|
+
This command can fail for the following reasons:
|
|
17
|
+
- The active user does not have permission to connect external services.
|
|
18
|
+
- The given credentials are invalid.
|
|
19
|
+
|
|
20
|
+
For more information on connecting to external services, see:
|
|
21
|
+
https://docs.uffizzi.com/references/cli/
|
|
22
|
+
|
|
23
|
+
For detailed instructions on configuring webhooks to send push
|
|
24
|
+
notifications to Uffizzi, see:
|
|
25
|
+
https://docs.uffizzi.com/guides/container-registry-integrations
|
|
26
|
+
|
|
27
|
+
## OPTIONS
|
|
28
|
+
|
|
29
|
+
* `-r`, `--registry=<registry>`:
|
|
30
|
+
URL of the service.
|
|
31
|
+
* `-u`, `--username=<username>`:
|
|
32
|
+
Username for the service.
|
|
33
|
+
* `-p`, `--password=<password>`:
|
|
34
|
+
Password for the service.
|
|
35
|
+
|
|
36
|
+
## EXAMPLES
|
|
37
|
+
|
|
38
|
+
The following command will prompt the user to enter Docker Container Registry
|
|
39
|
+
credentials, including username and password:
|
|
40
|
+
|
|
41
|
+
`uffizzi connect docker-registry`
|
|
@@ -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\-CONNECT\-ECR" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-connect\-ecr\fR \- grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBuffizzi connect ecr\fR [\-\-registry=REGISTRY] [\-\-id=ID] [\-\-secret=SECRET]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access to a private Amazon Elastic Container Registry
|
|
10
|
+
.P
|
|
11
|
+
Credentials can be provided interactively or non\-interactively via command options or environment variables:
|
|
12
|
+
.br
|
|
13
|
+
\fBAWS_REGISTRY_URL\fR, \fBAWS_ACCESS_KEY_ID\fR, \fBAWS_SECRET_ACCESS_KEY\fR
|
|
14
|
+
.P
|
|
15
|
+
This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
|
|
16
|
+
.P
|
|
17
|
+
For more information on connecting to external services, see:
|
|
18
|
+
.br
|
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
|
+
.P
|
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
|
22
|
+
.br
|
|
23
|
+
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
|
24
|
+
.SH "OPTIONS"
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-r\fR, \fB\-\-registry=<registry>\fR
|
|
27
|
+
URL of the service\.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-\-id=<id>\fR
|
|
30
|
+
Access key id for the service\.
|
|
31
|
+
.TP
|
|
32
|
+
\fB\-s\fR, \fB\-\-secret=<secret>\fR
|
|
33
|
+
Secret access key for the service\.
|
|
34
|
+
.SH "EXAMPLES"
|
|
35
|
+
The following command will prompt the user to enter ACR credentials, including registry domain, access key ID and secret access key:
|
|
36
|
+
.P
|
|
37
|
+
\fBuffizzi connect ecr\fR
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
|
|
2
|
+
|
|
3
|
+
## SYNOPSIS
|
|
4
|
+
|
|
5
|
+
`uffizzi connect ecr` [--registry=REGISTRY] [--id=ID] [--secret=SECRET]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access
|
|
10
|
+
to a private Amazon Elastic Container Registry
|
|
11
|
+
|
|
12
|
+
Credentials can be provided interactively or non-interactively
|
|
13
|
+
via command options or environment variables:
|
|
14
|
+
`AWS_REGISTRY_URL`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`
|
|
15
|
+
|
|
16
|
+
This command can fail for the following reasons:
|
|
17
|
+
- The active user does not have permission to connect external services.
|
|
18
|
+
- The given credentials are invalid.
|
|
19
|
+
|
|
20
|
+
For more information on connecting to external services, see:
|
|
21
|
+
https://docs.uffizzi.com/references/cli/
|
|
22
|
+
|
|
23
|
+
For detailed instructions on configuring webhooks to send push
|
|
24
|
+
notifications to Uffizzi, see:
|
|
25
|
+
https://docs.uffizzi.com/guides/container-registry-integrations
|
|
26
|
+
|
|
27
|
+
## OPTIONS
|
|
28
|
+
|
|
29
|
+
* `-r`, `--registry=<registry>`:
|
|
30
|
+
URL of the service.
|
|
31
|
+
* `--id=<id>`:
|
|
32
|
+
Access key id for the service.
|
|
33
|
+
* `-s`, `--secret=<secret>`:
|
|
34
|
+
Secret access key for the service.
|
|
35
|
+
|
|
36
|
+
## EXAMPLES
|
|
37
|
+
|
|
38
|
+
The following command will prompt the user to enter ACR
|
|
39
|
+
credentials, including registry domain, access key ID and
|
|
40
|
+
secret access key:
|
|
41
|
+
|
|
42
|
+
`uffizzi connect ecr`
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
+
.TH "UFFIZZI\-CONNECT\-GCR" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-connect\-gcr\fR \- grant a Uffizzi user account access to a private Google Container Registry (GCR)
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBuffizzi connect gcr\fR [KEY_FILE]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access to a private Google Container Registry
|
|
10
|
+
.P
|
|
11
|
+
Credentials can be provided via a key file or environment variable:
|
|
12
|
+
.br
|
|
13
|
+
\fBGCLOUD_SERVICE_KEY\fR
|
|
14
|
+
.P
|
|
15
|
+
This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
|
|
16
|
+
.P
|
|
17
|
+
For more information on connecting to external services, see:
|
|
18
|
+
.br
|
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
|
+
.P
|
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
|
22
|
+
.br
|
|
23
|
+
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
|
24
|
+
.SH "ARGUMENTS"
|
|
25
|
+
.TP
|
|
26
|
+
KEY_FILE
|
|
27
|
+
A Google Cloud service account key file\. The key file is a JSON file that grants Uffizzi access to a private GCR\.
|
|
28
|
+
.SH "EXAMPLES"
|
|
29
|
+
The following command uses a Google Cloud service account key file called sa\-private\-key\.json to connect to a private GCR:
|
|
30
|
+
.P
|
|
31
|
+
\fBuffizzi connect gcr sa\-private\-key\.json\fR
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
|
|
2
|
+
|
|
3
|
+
## SYNOPSIS
|
|
4
|
+
|
|
5
|
+
`uffizzi connect gcr` [KEY_FILE]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access
|
|
10
|
+
to a private Google Container Registry
|
|
11
|
+
|
|
12
|
+
Credentials can be provided via a key file or environment variable:
|
|
13
|
+
`GCLOUD_SERVICE_KEY`
|
|
14
|
+
|
|
15
|
+
This command can fail for the following reasons:
|
|
16
|
+
- The active user does not have permission to connect external services.
|
|
17
|
+
- The given credentials are invalid.
|
|
18
|
+
|
|
19
|
+
For more information on connecting to external services, see:
|
|
20
|
+
https://docs.uffizzi.com/references/cli/
|
|
21
|
+
|
|
22
|
+
For detailed instructions on configuring webhooks to send push
|
|
23
|
+
notifications to Uffizzi, see:
|
|
24
|
+
https://docs.uffizzi.com/guides/container-registry-integrations
|
|
25
|
+
|
|
26
|
+
## ARGUMENTS
|
|
27
|
+
|
|
28
|
+
* KEY_FILE:
|
|
29
|
+
A Google Cloud service account key file. The key file is a JSON file that grants Uffizzi access to a private GCR.
|
|
30
|
+
|
|
31
|
+
## EXAMPLES
|
|
32
|
+
|
|
33
|
+
The following command uses a Google Cloud service account key
|
|
34
|
+
file called sa-private-key.json to connect to a private GCR:
|
|
35
|
+
|
|
36
|
+
`uffizzi connect gcr sa-private-key.json`
|
|
@@ -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\-CONNECT\-GHCR" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-connect\-ghcr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
\fBuffizzi connect ghcr\fR [\-\-username=USERNAME] [\-\-token=TOKEN]
|
|
8
|
+
.SH "DESCRIPTION"
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access to a private GitHub Container Registry\.
|
|
10
|
+
.P
|
|
11
|
+
Credentials can be provided interactively or non\-interactively via command options or environment variables:
|
|
12
|
+
.br
|
|
13
|
+
\fBGITHUB_USERNAME\fR, \fBGITHUB_ACCESS_TOKEN\fR
|
|
14
|
+
.P
|
|
15
|
+
This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
|
|
16
|
+
.P
|
|
17
|
+
For more information on connecting to external services, see:
|
|
18
|
+
.br
|
|
19
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
20
|
+
.P
|
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
|
22
|
+
.br
|
|
23
|
+
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
|
24
|
+
.SH "OPTIONS"
|
|
25
|
+
.TP
|
|
26
|
+
\fB\-u\fR, \fB\-\-username=<username>\fR
|
|
27
|
+
Username for the service\.
|
|
28
|
+
.TP
|
|
29
|
+
\fB\-t\fR, \fB\-\-token=<token>\fR
|
|
30
|
+
Access token for the service\.
|
|
31
|
+
.SH "EXAMPLES"
|
|
32
|
+
The following command will prompt the user to enter GHCR credentials, including GitHub account name and personal access token (PAT):
|
|
33
|
+
.P
|
|
34
|
+
\fBuffizzi connect ghcr\fR
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
|
|
2
|
+
|
|
3
|
+
## SYNOPSIS
|
|
4
|
+
|
|
5
|
+
`uffizzi connect ghcr` [--username=USERNAME] [--token=TOKEN]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
|
|
9
|
+
Given valid credentials, grants a Uffizzi user account access
|
|
10
|
+
to a private GitHub Container Registry.
|
|
11
|
+
|
|
12
|
+
Credentials can be provided interactively or non-interactively
|
|
13
|
+
via command options or environment variables:
|
|
14
|
+
`GITHUB_USERNAME`, `GITHUB_ACCESS_TOKEN`
|
|
15
|
+
|
|
16
|
+
This command can fail for the following reasons:
|
|
17
|
+
- The active user does not have permission to connect external services.
|
|
18
|
+
- The given credentials are invalid.
|
|
19
|
+
|
|
20
|
+
For more information on connecting to external services, see:
|
|
21
|
+
https://docs.uffizzi.com/references/cli/
|
|
22
|
+
|
|
23
|
+
For detailed instructions on configuring webhooks to send push
|
|
24
|
+
notifications to Uffizzi, see:
|
|
25
|
+
https://docs.uffizzi.com/guides/container-registry-integrations
|
|
26
|
+
|
|
27
|
+
## OPTIONS
|
|
28
|
+
|
|
29
|
+
* `-u`, `--username=<username>`:
|
|
30
|
+
Username for the service.
|
|
31
|
+
* `-t`, `--token=<token>`:
|
|
32
|
+
Access token for the service.
|
|
33
|
+
|
|
34
|
+
## EXAMPLES
|
|
35
|
+
|
|
36
|
+
The following command will prompt the user to enter GHCR
|
|
37
|
+
credentials, including GitHub account name and
|
|
38
|
+
personal access token (PAT):
|
|
39
|
+
|
|
40
|
+
`uffizzi connect ghcr`
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# uffizzi-connect - grant a Uffizzi user account access to external services
|
|
2
|
+
|
|
3
|
+
## SYNOPSIS
|
|
4
|
+
|
|
5
|
+
`uffizzi connect` COMMAND [--skip-raise-existence-error] [--update-credential-if-exists]
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
|
|
9
|
+
Grants a Uffizzi user account access to external services.
|
|
10
|
+
|
|
11
|
+
For more information on connecting to external services, see:
|
|
12
|
+
https://docs.uffizzi.com/references/cli/
|
|
13
|
+
|
|
14
|
+
## COMMANDS
|
|
15
|
+
|
|
16
|
+
COMMAND is one of the following:
|
|
17
|
+
|
|
18
|
+
* `acr`:
|
|
19
|
+
Connect to Azure Container Registry (azurecr.io).
|
|
20
|
+
|
|
21
|
+
* `docker-hub`:
|
|
22
|
+
Connect to Docker Hub (hub.docker.com).
|
|
23
|
+
|
|
24
|
+
* `docker-registry`:
|
|
25
|
+
Connect to any registry implementing the Docker Registry HTTP API protocol
|
|
26
|
+
|
|
27
|
+
* `ecr`:
|
|
28
|
+
Connect to Amazon Elastic Container Registry (amazonaws.com).
|
|
29
|
+
|
|
30
|
+
* `gcr`:
|
|
31
|
+
Connect to Google Container Registry (gcr.io).
|
|
32
|
+
|
|
33
|
+
* `ghcr`:
|
|
34
|
+
Connect to GitHub Container Registry (ghcr.io).
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## FLAGS
|
|
38
|
+
|
|
39
|
+
* `--skip-raise-existence-error`:
|
|
40
|
+
If credential exists, do not raise an exception, just print a message.
|
|
41
|
+
|
|
42
|
+
* `--update-credential-if-exists`:
|
|
43
|
+
Update credential if it exists.
|
|
44
|
+
|
|
45
|
+
Run `uffizzi connect COMMAND --help` for more information on a command.
|
|
@@ -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\-DISCONNECT" "" "August 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-disconnect\fR \- revoke a Uffizzi user account access to external services
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
.nf
|
|
8
|
+
uffizzi disconnect COMMAND
|
|
9
|
+
.fi
|
|
10
|
+
.SH "DESCRIPTION"
|
|
11
|
+
.nf
|
|
12
|
+
Revokes a Uffizzi user account access to external services
|
|
13
|
+
|
|
14
|
+
For more information on connecting to external services, see:
|
|
15
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
16
|
+
.fi
|
|
17
|
+
.SH "COMMANDS"
|
|
18
|
+
.nf
|
|
19
|
+
COMMAND is one of the following:
|
|
20
|
+
|
|
21
|
+
acr
|
|
22
|
+
Disonnect from Azure Container Registry (azurecr\.io)\.
|
|
23
|
+
|
|
24
|
+
docker\-hub
|
|
25
|
+
Disonnect from Docker Hub (hub\.docker\.com)\.
|
|
26
|
+
|
|
27
|
+
ecr
|
|
28
|
+
Disonnect from Amazon Elastic Container Registry (amazonaws\.com)\.
|
|
29
|
+
|
|
30
|
+
gcr
|
|
31
|
+
Disonnect from Google Container Registry (gcr\.io)\.
|
|
32
|
+
|
|
33
|
+
ghcr
|
|
34
|
+
Disonnect from GitHub Container Registry (ghcr\.io)\.
|
|
35
|
+
.fi
|
|
36
|
+
.P
|
|
37
|
+
Run \'uffizzi disconnect COMMAND \-\-help\' for more information on a command\.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
uffizzi-disconnect - revoke a Uffizzi user account access to external services
|
|
2
|
+
================================================================
|
|
3
|
+
|
|
4
|
+
## SYNOPSIS
|
|
5
|
+
uffizzi disconnect COMMAND
|
|
6
|
+
|
|
7
|
+
## DESCRIPTION
|
|
8
|
+
Revokes a Uffizzi user account access to external services
|
|
9
|
+
|
|
10
|
+
For more information on connecting to external services, see:
|
|
11
|
+
https://docs.uffizzi.com/references/cli/
|
|
12
|
+
|
|
13
|
+
## COMMANDS
|
|
14
|
+
COMMAND is one of the following:
|
|
15
|
+
|
|
16
|
+
acr
|
|
17
|
+
Disonnect from Azure Container Registry (azurecr.io).
|
|
18
|
+
|
|
19
|
+
docker-hub
|
|
20
|
+
Disonnect from Docker Hub (hub.docker.com).
|
|
21
|
+
|
|
22
|
+
ecr
|
|
23
|
+
Disonnect from Amazon Elastic Container Registry (amazonaws.com).
|
|
24
|
+
|
|
25
|
+
gcr
|
|
26
|
+
Disonnect from Google Container Registry (gcr.io).
|
|
27
|
+
|
|
28
|
+
ghcr
|
|
29
|
+
Disonnect from GitHub Container Registry (ghcr.io).
|
|
30
|
+
|
|
31
|
+
Run 'uffizzi disconnect COMMAND --help' for more information on a command.
|
data/man/uffizzi-login
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
|
3
|
+
.TH "UFFIZZI\-LOGIN" "" "September 2023" ""
|
|
4
|
+
.SH "NAME"
|
|
5
|
+
\fBuffizzi\-login\fR \- login to Uffizzi to view and manage your previews\.
|
|
6
|
+
.SH "SYNOPSIS"
|
|
7
|
+
.nf
|
|
8
|
+
uffizzi login [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
|
9
|
+
.fi
|
|
10
|
+
.SH "DESCRIPTION"
|
|
11
|
+
.nf
|
|
12
|
+
The uffizzi login command lets you authenticate with Uffizzi\.
|
|
13
|
+
|
|
14
|
+
For more information on authentication and credential types, see:
|
|
15
|
+
https://docs\.uffizzi\.com/references/cli/
|
|
16
|
+
.fi
|
|
17
|
+
.SH "FLAGS"
|
|
18
|
+
.nf
|
|
19
|
+
\-\-email
|
|
20
|
+
Login using an email and a password
|
|
21
|
+
.fi
|
|
22
|
+
.SH "OPTIONS"
|
|
23
|
+
.nf
|
|
24
|
+
OPTION is one of the following:
|
|
25
|
+
|
|
26
|
+
\-\-server
|
|
27
|
+
Login with an alternative server\.
|
|
28
|
+
|
|
29
|
+
\-\-username
|
|
30
|
+
Login with a username different from the one in the config
|
|
31
|
+
.fi
|
|
32
|
+
.SH "UFFIZZI WIDE FLAGS"
|
|
33
|
+
.nf
|
|
34
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
|
35
|
+
help for details\.
|
|
36
|
+
.fi
|
|
37
|
+
.SH "EXAMPLES"
|
|
38
|
+
.nf
|
|
39
|
+
To login via the browser, run:
|
|
40
|
+
|
|
41
|
+
$ uffizzi login
|
|
42
|
+
|
|
43
|
+
To login to the default host with the default user account, run:
|
|
44
|
+
|
|
45
|
+
$ uffizzi login \-\-email
|
|
46
|
+
|
|
47
|
+
To login to an alternate host, run:
|
|
48
|
+
|
|
49
|
+
$ uffizzi login \-\-server=uffizzi\.example\.com
|
|
50
|
+
.fi
|
|
51
|
+
|