uffizzi-cli 0.11.5 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/config/uffizzi.rb +1 -0
- data/lib/uffizzi/cli/connect.rb +95 -46
- data/lib/uffizzi/cli/disconnect.rb +5 -2
- data/lib/uffizzi/cli/login.rb +11 -6
- data/lib/uffizzi/cli/login_by_identity_token.rb +47 -0
- data/lib/uffizzi/cli/preview.rb +95 -34
- data/lib/uffizzi/cli/project.rb +3 -1
- data/lib/uffizzi/cli.rb +8 -0
- data/lib/uffizzi/clients/api/api_client.rb +21 -14
- data/lib/uffizzi/clients/api/api_routes.rb +18 -8
- data/lib/uffizzi/clients/api/http_client.rb +4 -4
- data/lib/uffizzi/helpers/connect_helper.rb +45 -0
- data/lib/uffizzi/services/project_service.rb +1 -0
- data/lib/uffizzi/version.rb +1 -1
- data/man/uffizzi-connect +30 -31
- data/man/uffizzi-connect-acr +27 -25
- data/man/uffizzi-connect-acr.ronn +33 -19
- data/man/uffizzi-connect-docker-hub +24 -24
- data/man/uffizzi-connect-docker-hub.ronn +30 -18
- data/man/uffizzi-connect-docker-registry +37 -0
- data/man/uffizzi-connect-docker-registry.ronn +41 -0
- data/man/uffizzi-connect-ecr +27 -25
- data/man/uffizzi-connect-ecr.ronn +33 -19
- data/man/uffizzi-connect-gcr +20 -29
- data/man/uffizzi-connect-gcr.ronn +26 -22
- data/man/uffizzi-connect-ghcr +23 -33
- data/man/uffizzi-connect-ghcr.ronn +27 -23
- data/man/uffizzi-connect.ronn +28 -20
- 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-preview-create +16 -1
- data/man/uffizzi-preview-create.ronn +14 -0
- data/man/uffizzi-preview-list +25 -1
- data/man/uffizzi-preview-list.ronn +23 -0
- data/man/uffizzi-preview-update +20 -2
- data/man/uffizzi-preview-update.ronn +17 -0
- metadata +9 -2
data/man/uffizzi-connect-ecr
CHANGED
@@ -1,35 +1,37 @@
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
-
.TH "UFFIZZI\-CONNECT\-ECR" "" "
|
3
|
+
.TH "UFFIZZI\-CONNECT\-ECR" "" "August 2022" ""
|
4
4
|
.SH "NAME"
|
5
5
|
\fBuffizzi\-connect\-ecr\fR \- grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
|
6
6
|
.SH "SYNOPSIS"
|
7
|
-
|
8
|
-
uffizzi connect ecr
|
9
|
-
.fi
|
7
|
+
\fBuffizzi connect ecr\fR [\-\-registry=REGISTRY] [\-\-id=ID] [\-\-secret=SECRET]
|
10
8
|
.SH "DESCRIPTION"
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
20
17
|
For more information on connecting to external services, see:
|
18
|
+
.br
|
21
19
|
https://github\.com/UffizziCloud/uffizzi_cli
|
22
|
-
|
23
|
-
For detailed instructions on configuring webhooks to send push
|
24
|
-
|
20
|
+
.P
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
22
|
+
.br
|
25
23
|
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
26
|
-
.
|
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\.
|
27
34
|
.SH "EXAMPLES"
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
secret access key:
|
32
|
-
|
33
|
-
$ uffizzi connect ecr
|
34
|
-
.fi
|
35
|
-
|
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
|
@@ -1,28 +1,42 @@
|
|
1
|
-
uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
|
2
|
-
================================================================
|
1
|
+
# uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
|
3
2
|
|
4
3
|
## SYNOPSIS
|
5
|
-
|
4
|
+
|
5
|
+
`uffizzi connect ecr` [--registry=REGISTRY] [--id=ID] [--secret=SECRET]
|
6
6
|
|
7
7
|
## DESCRIPTION
|
8
|
-
Given valid credentials, grants a Uffizzi user account access
|
9
|
-
to a private Amazon Elastic Container Registry
|
10
8
|
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
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://github.com/UffizziCloud/uffizzi_cli
|
15
22
|
|
16
|
-
|
17
|
-
|
23
|
+
For detailed instructions on configuring webhooks to send push
|
24
|
+
notifications to Uffizzi, see:
|
25
|
+
https://docs.uffizzi.com/guides/container-registry-integrations
|
18
26
|
|
19
|
-
|
20
|
-
|
21
|
-
|
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.
|
22
35
|
|
23
36
|
## EXAMPLES
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
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`
|
data/man/uffizzi-connect-gcr
CHANGED
@@ -1,40 +1,31 @@
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
-
.TH "UFFIZZI\-CONNECT\-GCR" "" "
|
3
|
+
.TH "UFFIZZI\-CONNECT\-GCR" "" "August 2022" ""
|
4
4
|
.SH "NAME"
|
5
5
|
\fBuffizzi\-connect\-gcr\fR \- grant a Uffizzi user account access to a private Google Container Registry (GCR)
|
6
6
|
.SH "SYNOPSIS"
|
7
|
-
|
8
|
-
uffizzi connect gcr [KEY_FILE]
|
9
|
-
.fi
|
7
|
+
\fBuffizzi connect gcr\fR [KEY_FILE]
|
10
8
|
.SH "DESCRIPTION"
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
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
|
20
17
|
For more information on connecting to external services, see:
|
18
|
+
.br
|
21
19
|
https://github\.com/UffizziCloud/uffizzi_cli
|
22
|
-
|
23
|
-
For detailed instructions on configuring webhooks to send push
|
24
|
-
|
20
|
+
.P
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
22
|
+
.br
|
25
23
|
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
26
|
-
.
|
27
|
-
.
|
28
|
-
.nf
|
24
|
+
.SH "ARGUMENTS"
|
25
|
+
.TP
|
29
26
|
KEY_FILE
|
30
|
-
|
31
|
-
JSON file that grants Uffizzi access to a private GCR\.
|
32
|
-
.fi
|
27
|
+
A Google Cloud service account key file\. The key file is a JSON file that grants Uffizzi access to a private GCR\.
|
33
28
|
.SH "EXAMPLES"
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
$ uffizzi connect gcr sa\-private\-key\.json
|
39
|
-
.fi
|
40
|
-
|
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
|
@@ -1,32 +1,36 @@
|
|
1
|
-
uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
|
2
|
-
================================================================
|
1
|
+
# uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
|
3
2
|
|
4
3
|
## SYNOPSIS
|
5
|
-
|
4
|
+
|
5
|
+
`uffizzi connect gcr` [KEY_FILE]
|
6
6
|
|
7
7
|
## DESCRIPTION
|
8
|
-
Given valid credentials, grants a Uffizzi user account access
|
9
|
-
to a private Google Container Registry
|
10
8
|
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
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.
|
15
18
|
|
16
|
-
|
17
|
-
|
19
|
+
For more information on connecting to external services, see:
|
20
|
+
https://github.com/UffizziCloud/uffizzi_cli
|
18
21
|
|
19
|
-
|
20
|
-
|
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
|
22
25
|
|
23
|
-
##
|
24
|
-
|
25
|
-
|
26
|
-
|
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.
|
27
30
|
|
28
31
|
## EXAMPLES
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
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`
|
data/man/uffizzi-connect-ghcr
CHANGED
@@ -1,44 +1,34 @@
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
-
.TH "UFFIZZI\-CONNECT\-GHCR" "" "
|
3
|
+
.TH "UFFIZZI\-CONNECT\-GHCR" "" "August 2022" ""
|
4
4
|
.SH "NAME"
|
5
5
|
\fBuffizzi\-connect\-ghcr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
|
6
6
|
.SH "SYNOPSIS"
|
7
|
-
|
8
|
-
uffizzi connect ghcr [OPTION]\|\.\|\.\|\.
|
9
|
-
.fi
|
7
|
+
\fBuffizzi connect ghcr\fR [\-\-username=USERNAME] [\-\-token=TOKEN]
|
10
8
|
.SH "DESCRIPTION"
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
This command can fail for the following reasons:
|
20
|
-
\- The active user does not have permission to connect
|
21
|
-
external services\.
|
22
|
-
\- The given credentials are invalid\.
|
23
|
-
|
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
|
24
17
|
For more information on connecting to external services, see:
|
18
|
+
.br
|
25
19
|
https://github\.com/UffizziCloud/uffizzi_cli
|
26
|
-
|
27
|
-
For detailed instructions on configuring webhooks to send push
|
28
|
-
|
20
|
+
.P
|
21
|
+
For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
|
22
|
+
.br
|
29
23
|
https://docs\.uffizzi\.com/guides/container\-registry\-integrations
|
30
|
-
.fi
|
31
24
|
.SH "OPTIONS"
|
32
|
-
.
|
33
|
-
\-u, \-\-username
|
34
|
-
|
35
|
-
.
|
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\.
|
36
31
|
.SH "EXAMPLES"
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
personal access token (PAT):
|
41
|
-
|
42
|
-
uffizzi connect ghcr
|
43
|
-
.fi
|
44
|
-
|
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
|
@@ -1,36 +1,40 @@
|
|
1
|
-
uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
|
2
|
-
================================================================
|
1
|
+
# uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
|
3
2
|
|
4
3
|
## SYNOPSIS
|
5
|
-
|
4
|
+
|
5
|
+
`uffizzi connect ghcr` [--username=USERNAME] [--token=TOKEN]
|
6
6
|
|
7
7
|
## DESCRIPTION
|
8
|
-
Given valid credentials, grants a Uffizzi user account access
|
9
|
-
to a private GitHub Container Registry.
|
10
8
|
|
11
|
-
|
12
|
-
|
13
|
-
|
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`
|
14
15
|
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
- The given credentials are invalid.
|
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
19
|
|
20
|
-
|
21
|
-
|
20
|
+
For more information on connecting to external services, see:
|
21
|
+
https://github.com/UffizziCloud/uffizzi_cli
|
22
22
|
|
23
|
-
|
24
|
-
|
25
|
-
|
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
26
|
|
27
27
|
## OPTIONS
|
28
|
-
|
29
|
-
|
28
|
+
|
29
|
+
* `-u`, `--username=<username>`:
|
30
|
+
Username for the service.
|
31
|
+
* `-t`, `--token=<token>`:
|
32
|
+
Access token for the service.
|
30
33
|
|
31
34
|
## EXAMPLES
|
32
|
-
The following command will prompt the user to enter GHCR
|
33
|
-
credentials, including GitHub account name and
|
34
|
-
personal access token (PAT):
|
35
35
|
|
36
|
-
|
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`
|
data/man/uffizzi-connect.ronn
CHANGED
@@ -1,37 +1,45 @@
|
|
1
|
-
uffizzi-connect - grant a Uffizzi user account access to external services
|
2
|
-
================================================================
|
1
|
+
# uffizzi-connect - grant a Uffizzi user account access to external services
|
3
2
|
|
4
3
|
## SYNOPSIS
|
5
|
-
|
4
|
+
|
5
|
+
`uffizzi connect` COMMAND [--skip-raise-existence-error] [--update-credential-if-exists]
|
6
6
|
|
7
7
|
## DESCRIPTION
|
8
|
-
Grants a Uffizzi user account access to external services
|
9
8
|
|
10
|
-
|
11
|
-
|
9
|
+
Grants a Uffizzi user account access to external services.
|
10
|
+
|
11
|
+
For more information on connecting to external services, see:
|
12
|
+
https://github.com/UffizziCloud/uffizzi_cli
|
12
13
|
|
13
14
|
## COMMANDS
|
14
|
-
COMMAND is one of the following:
|
15
15
|
|
16
|
-
|
17
|
-
|
16
|
+
COMMAND is one of the following:
|
17
|
+
|
18
|
+
* `acr`:
|
19
|
+
Connect to Azure Container Registry (azurecr.io).
|
18
20
|
|
19
|
-
|
20
|
-
|
21
|
+
* `docker-hub`:
|
22
|
+
Connect to Docker Hub (hub.docker.com).
|
21
23
|
|
22
|
-
|
23
|
-
|
24
|
+
* `docker-registry`:
|
25
|
+
Connect to any registry implementing the Docker Registry HTTP API protocol
|
24
26
|
|
25
|
-
|
26
|
-
|
27
|
+
* `ecr`:
|
28
|
+
Connect to Amazon Elastic Container Registry (amazonaws.com).
|
27
29
|
|
28
|
-
|
29
|
-
|
30
|
+
* `gcr`:
|
31
|
+
Connect to Google Container Registry (gcr.io).
|
32
|
+
|
33
|
+
* `ghcr`:
|
34
|
+
Connect to GitHub Container Registry (ghcr.io).
|
30
35
|
|
31
36
|
|
32
37
|
## FLAGS
|
33
|
-
--skip-raise-existence-error If credential exist, do not raise an exception, just print a message
|
34
38
|
|
35
|
-
|
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.
|
36
44
|
|
37
|
-
Run
|
45
|
+
Run `uffizzi connect COMMAND --help` for more information on a command.
|
@@ -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 2022" ""
|
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://github\.com/UffizziCloud/uffizzi_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 \-\-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://github.com/UffizziCloud/uffizzi_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 --token=[$CI_JOB_TOKEN]
|
data/man/uffizzi-preview-create
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
.\" generated with Ronn-NG/v0.9.1
|
2
2
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
3
|
-
.TH "UFFIZZI\-PREVIEW\-CREATE" "" "
|
3
|
+
.TH "UFFIZZI\-PREVIEW\-CREATE" "" "August 2022" ""
|
4
4
|
.SH "NAME"
|
5
5
|
\fBuffizzi\-preview\-create\fR \- create a preview
|
6
6
|
.SH "SYNOPSIS"
|
@@ -32,6 +32,12 @@ https://github\.com/UffizziCloud/uffizzi_cli
|
|
32
32
|
the previews they create: when the preview is deleted, the
|
33
33
|
alternate compose is deleted by the Uffizzi API\.
|
34
34
|
.fi
|
35
|
+
.SH "FLAGS"
|
36
|
+
.nf
|
37
|
+
\-\-set\-labels=METADATA
|
38
|
+
Metadata of deployment that contains any information which can
|
39
|
+
be usefull for filtering deployments\.
|
40
|
+
.fi
|
35
41
|
.SH "UFFIZZI WIDE FLAGS"
|
36
42
|
.nf
|
37
43
|
These flags are available to all commands: \-\-project\. Run $ uffizzi
|
@@ -46,5 +52,14 @@ To create a preview with the project\'s default compose file, run:
|
|
46
52
|
To create a preview with an alternate compose file, run:
|
47
53
|
|
48
54
|
$ uffizzi preview create docker\-compose\.uffizzi\.alt\.yml
|
55
|
+
|
56
|
+
To create a preview with single label, run:
|
57
|
+
|
58
|
+
$ uffizzi preview create \-\-set\-labels github\.repo=my_repo
|
59
|
+
|
60
|
+
To create a preview with multiple labels, run:
|
61
|
+
|
62
|
+
$ uffizzi preview create \e
|
63
|
+
\-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
|
49
64
|
.fi
|
50
65
|
|