uffizzi-cli 2.0.34 → 2.0.36
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/cluster.rb +34 -5
- data/lib/uffizzi/cli/common.rb +1 -1
- data/lib/uffizzi/cli/project/compose.rb +2 -0
- data/lib/uffizzi/helpers/config_helper.rb +17 -0
- data/lib/uffizzi/services/cluster/disconnect_service.rb +71 -0
- data/lib/uffizzi/services/kubeconfig_service.rb +33 -8
- 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-disconnect +40 -0
- data/man/uffizzi-cluster-disconnect.ronn +32 -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 +126 -2
@@ -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
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-LOGIN\-BY\-IDENTITY\-TOKEN" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-login\-by\-identity\-token\fR \- login to Uffizzi using a OIDC token provided by a CI/CD pipeline
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
.nf
|
8
|
+
uffizzi uffizzi\-login\-by\-identity\-token [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
|
9
|
+
.fi
|
10
|
+
.SH "DESCRIPTION"
|
11
|
+
.nf
|
12
|
+
The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline\.
|
13
|
+
If a user/account do not exist, Uffizzi will create them based on token payload\.
|
14
|
+
|
15
|
+
For more information on authentication and credential types, see:
|
16
|
+
https://docs\.uffizzi\.com/references/cli/
|
17
|
+
.fi
|
18
|
+
.SH "UFFIZZI WIDE FLAGS"
|
19
|
+
.nf
|
20
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
21
|
+
help for details\.
|
22
|
+
.fi
|
23
|
+
.SH "EXAMPLES"
|
24
|
+
.nf
|
25
|
+
To login from the CI/CD pipeline, run:
|
26
|
+
|
27
|
+
$ uffizzi uffizzi\-login\-by\-identity\-token \-\-server=uffizzi\.example\.com \-\-oidc\-token=[$CI_JOB_TOKEN]
|
28
|
+
.fi
|
29
|
+
|
@@ -0,0 +1,106 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta http-equiv='content-type' content='text/html;charset=utf8'>
|
5
|
+
<meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
|
6
|
+
<title>login to Uffizzi using a OIDC token provided by a CI/CD pipeline</title>
|
7
|
+
<style type='text/css' media='all'>
|
8
|
+
/* style: man */
|
9
|
+
body#manpage {margin:0}
|
10
|
+
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
11
|
+
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
12
|
+
.mp h2 {margin:10px 0 0 0}
|
13
|
+
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
14
|
+
.mp h3 {margin:0 0 0 4ex}
|
15
|
+
.mp dt {margin:0;clear:left}
|
16
|
+
.mp dt.flush {float:left;width:8ex}
|
17
|
+
.mp dd {margin:0 0 0 9ex}
|
18
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
19
|
+
.mp pre {margin-bottom:20px}
|
20
|
+
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
21
|
+
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
22
|
+
.mp img {display:block;margin:auto}
|
23
|
+
.mp h1.man-title {display:none}
|
24
|
+
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
25
|
+
.mp h2 {font-size:16px;line-height:1.25}
|
26
|
+
.mp h1 {font-size:20px;line-height:2}
|
27
|
+
.mp {text-align:justify;background:#fff}
|
28
|
+
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
29
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
30
|
+
.mp u {text-decoration:underline}
|
31
|
+
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
32
|
+
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
33
|
+
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
34
|
+
.mp b.man-ref {font-weight:normal;color:#434241}
|
35
|
+
.mp pre {padding:0 4ex}
|
36
|
+
.mp pre code {font-weight:normal;color:#434241}
|
37
|
+
.mp h2+pre,h3+pre {padding-left:0}
|
38
|
+
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
39
|
+
ol.man-decor {width:100%}
|
40
|
+
ol.man-decor li.tl {text-align:left}
|
41
|
+
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
42
|
+
ol.man-decor li.tr {text-align:right;float:right}
|
43
|
+
</style>
|
44
|
+
</head>
|
45
|
+
<!--
|
46
|
+
The following styles are deprecated and will be removed at some point:
|
47
|
+
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
48
|
+
|
49
|
+
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
50
|
+
.man-navigation should be used instead.
|
51
|
+
-->
|
52
|
+
<body id='manpage'>
|
53
|
+
<div class='mp' id='man'>
|
54
|
+
|
55
|
+
<div class='man-navigation' style='display:none'>
|
56
|
+
<a href="#NAME">NAME</a>
|
57
|
+
<a href="#SYNOPSIS">SYNOPSIS</a>
|
58
|
+
<a href="#DESCRIPTION">DESCRIPTION</a>
|
59
|
+
<a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
|
60
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
61
|
+
</div>
|
62
|
+
|
63
|
+
<ol class='man-decor man-head man head'>
|
64
|
+
<li class='tl'>uffizzi-login-by-identity-token</li>
|
65
|
+
<li class='tc'></li>
|
66
|
+
<li class='tr'>uffizzi-login-by-identity-token</li>
|
67
|
+
</ol>
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
<h2 id="NAME">NAME</h2>
|
72
|
+
<p class="man-name">
|
73
|
+
<code>uffizzi-login-by-identity-token</code> - <span class="man-whatis">login to Uffizzi using a OIDC token provided by a CI/CD pipeline</span>
|
74
|
+
</p>
|
75
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
76
|
+
<pre><code>uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
|
77
|
+
</code></pre>
|
78
|
+
|
79
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
80
|
+
<pre><code>The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
|
81
|
+
If a user/account do not exist, Uffizzi will create them based on token payload.
|
82
|
+
|
83
|
+
For more information on authentication and credential types, see:
|
84
|
+
https://github.com/UffizziCloud/uffizzi_cli
|
85
|
+
</code></pre>
|
86
|
+
|
87
|
+
<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
|
88
|
+
<pre><code>These flags are available to all commands: --project. Run $ uffizzi
|
89
|
+
help for details.
|
90
|
+
</code></pre>
|
91
|
+
|
92
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
93
|
+
<pre><code>To login from the CI/CD pipeline, run:
|
94
|
+
|
95
|
+
$ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --token=[$CI_JOB_TOKEN]
|
96
|
+
</code></pre>
|
97
|
+
|
98
|
+
<ol class='man-decor man-foot man foot'>
|
99
|
+
<li class='tl'></li>
|
100
|
+
<li class='tc'>August 2022</li>
|
101
|
+
<li class='tr'>uffizzi-login-by-identity-token</li>
|
102
|
+
</ol>
|
103
|
+
|
104
|
+
</div>
|
105
|
+
</body>
|
106
|
+
</html>
|
@@ -0,0 +1,21 @@
|
|
1
|
+
uffizzi-login-by-identity-token - login to Uffizzi using a OIDC token provided by a CI/CD pipeline
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
|
9
|
+
If a user/account do not exist, Uffizzi will create them based on token payload.
|
10
|
+
|
11
|
+
For more information on authentication and credential types, see:
|
12
|
+
https://docs.uffizzi.com/references/cli/
|
13
|
+
|
14
|
+
## UFFIZZI WIDE FLAGS
|
15
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
16
|
+
help for details.
|
17
|
+
|
18
|
+
## EXAMPLES
|
19
|
+
To login from the CI/CD pipeline, run:
|
20
|
+
|
21
|
+
$ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --oidc-token=[$CI_JOB_TOKEN]
|
@@ -0,0 +1,113 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta http-equiv='content-type' content='text/html;charset=utf8'>
|
5
|
+
<meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
|
6
|
+
<title>login to Uffizzi to view and manage your previews.</title>
|
7
|
+
<style type='text/css' media='all'>
|
8
|
+
/* style: man */
|
9
|
+
body#manpage {margin:0}
|
10
|
+
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
11
|
+
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
12
|
+
.mp h2 {margin:10px 0 0 0}
|
13
|
+
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
14
|
+
.mp h3 {margin:0 0 0 4ex}
|
15
|
+
.mp dt {margin:0;clear:left}
|
16
|
+
.mp dt.flush {float:left;width:8ex}
|
17
|
+
.mp dd {margin:0 0 0 9ex}
|
18
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
19
|
+
.mp pre {margin-bottom:20px}
|
20
|
+
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
21
|
+
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
22
|
+
.mp img {display:block;margin:auto}
|
23
|
+
.mp h1.man-title {display:none}
|
24
|
+
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
25
|
+
.mp h2 {font-size:16px;line-height:1.25}
|
26
|
+
.mp h1 {font-size:20px;line-height:2}
|
27
|
+
.mp {text-align:justify;background:#fff}
|
28
|
+
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
29
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
30
|
+
.mp u {text-decoration:underline}
|
31
|
+
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
32
|
+
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
33
|
+
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
34
|
+
.mp b.man-ref {font-weight:normal;color:#434241}
|
35
|
+
.mp pre {padding:0 4ex}
|
36
|
+
.mp pre code {font-weight:normal;color:#434241}
|
37
|
+
.mp h2+pre,h3+pre {padding-left:0}
|
38
|
+
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
39
|
+
ol.man-decor {width:100%}
|
40
|
+
ol.man-decor li.tl {text-align:left}
|
41
|
+
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
42
|
+
ol.man-decor li.tr {text-align:right;float:right}
|
43
|
+
</style>
|
44
|
+
</head>
|
45
|
+
<!--
|
46
|
+
The following styles are deprecated and will be removed at some point:
|
47
|
+
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
48
|
+
|
49
|
+
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
50
|
+
.man-navigation should be used instead.
|
51
|
+
-->
|
52
|
+
<body id='manpage'>
|
53
|
+
<div class='mp' id='man'>
|
54
|
+
|
55
|
+
<div class='man-navigation' style='display:none'>
|
56
|
+
<a href="#NAME">NAME</a>
|
57
|
+
<a href="#SYNOPSIS">SYNOPSIS</a>
|
58
|
+
<a href="#DESCRIPTION">DESCRIPTION</a>
|
59
|
+
<a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
|
60
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
61
|
+
</div>
|
62
|
+
|
63
|
+
<ol class='man-decor man-head man head'>
|
64
|
+
<li class='tl'>uffizzi-login</li>
|
65
|
+
<li class='tc'></li>
|
66
|
+
<li class='tr'>uffizzi-login</li>
|
67
|
+
</ol>
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
<h2 id="NAME">NAME</h2>
|
72
|
+
<p class="man-name">
|
73
|
+
<code>uffizzi-login</code> - <span class="man-whatis">login to Uffizzi to view and manage your previews.</span>
|
74
|
+
</p>
|
75
|
+
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
76
|
+
<pre><code>uffizzi login [UFFIZZI_WIDE_FLAG ...]
|
77
|
+
</code></pre>
|
78
|
+
|
79
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
80
|
+
<pre><code>The uffizzi login command lets you authenticate with Uffizzi.
|
81
|
+
|
82
|
+
For more information on authentication and credential types, see:
|
83
|
+
https://github.com/UffizziCloud/uffizzi_cli
|
84
|
+
</code></pre>
|
85
|
+
|
86
|
+
<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
|
87
|
+
<pre><code>These flags are available to all commands: --project. Run $ uffizzi
|
88
|
+
help for details.
|
89
|
+
</code></pre>
|
90
|
+
|
91
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
92
|
+
<pre><code>To login via the browser, run:
|
93
|
+
|
94
|
+
$ uffizzi login
|
95
|
+
|
96
|
+
To login to the default host with the default user account, run:
|
97
|
+
|
98
|
+
$ uffizzi login --email
|
99
|
+
|
100
|
+
To login to an alternate host, run:
|
101
|
+
|
102
|
+
$ uffizzi login --server=uffizzi.example.com
|
103
|
+
</code></pre>
|
104
|
+
|
105
|
+
<ol class='man-decor man-foot man foot'>
|
106
|
+
<li class='tl'></li>
|
107
|
+
<li class='tc'>July 2023</li>
|
108
|
+
<li class='tr'>uffizzi-login</li>
|
109
|
+
</ol>
|
110
|
+
|
111
|
+
</div>
|
112
|
+
</body>
|
113
|
+
</html>
|
@@ -0,0 +1,41 @@
|
|
1
|
+
uffizzi-login - login to Uffizzi to view and manage your previews.
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
uffizzi login [UFFIZZI_WIDE_FLAG ...]
|
6
|
+
|
7
|
+
## DESCRIPTION
|
8
|
+
The uffizzi login command lets you authenticate with Uffizzi.
|
9
|
+
|
10
|
+
For more information on authentication and credential types, see:
|
11
|
+
https://docs.uffizzi.com/references/cli/
|
12
|
+
|
13
|
+
## FLAGS
|
14
|
+
--email
|
15
|
+
Login using an email and a password
|
16
|
+
|
17
|
+
## OPTIONS
|
18
|
+
OPTION is one of the following:
|
19
|
+
|
20
|
+
--server
|
21
|
+
Login with an alternative server.
|
22
|
+
|
23
|
+
--username
|
24
|
+
Login with a username different from the one in the config
|
25
|
+
|
26
|
+
## UFFIZZI WIDE FLAGS
|
27
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
28
|
+
help for details.
|
29
|
+
|
30
|
+
## EXAMPLES
|
31
|
+
To login via the browser, run:
|
32
|
+
|
33
|
+
$ uffizzi login
|
34
|
+
|
35
|
+
To login to the default host with the default user account, run:
|
36
|
+
|
37
|
+
$ uffizzi login --email
|
38
|
+
|
39
|
+
To login to an alternate host, run:
|
40
|
+
|
41
|
+
$ uffizzi login --server=uffizzi.example.com
|
data/man/uffizzi-logout
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
.\" generated with Ronn-NG/v0.9.1
|
2
|
+
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
+
.TH "UFFIZZI\-LOGOUT" "" "August 2023" ""
|
4
|
+
.SH "NAME"
|
5
|
+
\fBuffizzi\-logout\fR \- log out of a Uffizzi user account
|
6
|
+
.SH "SYNOPSIS"
|
7
|
+
\fBuffizzi logout\fR
|
8
|
+
.SH "DESCRIPTION"
|
9
|
+
.nf
|
10
|
+
The uffizzi logout command logs out of a Uffizzi user account\.
|
11
|
+
|
12
|
+
For more information on logout, see:
|
13
|
+
https://docs\.uffizzi\.com/references/cli/
|
14
|
+
.fi
|
15
|
+
.SH "UFFIZZI WIDE FLAGS"
|
16
|
+
.nf
|
17
|
+
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
18
|
+
help for details\.
|
19
|
+
.fi
|
20
|
+
.SH "EXAMPLES"
|
21
|
+
uffizzi logout
|
@@ -0,0 +1,19 @@
|
|
1
|
+
uffizzi-logout - log out of a Uffizzi user account
|
2
|
+
================================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
|
6
|
+
`uffizzi logout`
|
7
|
+
|
8
|
+
## DESCRIPTION
|
9
|
+
The uffizzi logout command logs out of a Uffizzi user account.
|
10
|
+
|
11
|
+
For more information on logout, see:
|
12
|
+
https://docs.uffizzi.com/references/cli/
|
13
|
+
|
14
|
+
## UFFIZZI WIDE FLAGS
|
15
|
+
These flags are available to all commands: --project. Run $ uffizzi
|
16
|
+
help for details.
|
17
|
+
|
18
|
+
## EXAMPLES
|
19
|
+
uffizzi logout
|