uffizzi-cli 0.11.3 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (24) hide show
  1. checksums.yaml +4 -4
  2. data/config/uffizzi.rb +1 -0
  3. data/lib/uffizzi/cli/connect.rb +109 -49
  4. data/lib/uffizzi/cli/disconnect.rb +4 -1
  5. data/lib/uffizzi/clients/api/api_client.rb +8 -1
  6. data/lib/uffizzi/clients/api/api_routes.rb +1 -1
  7. data/lib/uffizzi/helpers/connect_helper.rb +45 -0
  8. data/lib/uffizzi/services/compose_file_service.rb +1 -1
  9. data/lib/uffizzi/version.rb +1 -1
  10. data/man/uffizzi-connect +31 -26
  11. data/man/uffizzi-connect-acr +27 -25
  12. data/man/uffizzi-connect-acr.ronn +33 -19
  13. data/man/uffizzi-connect-docker-hub +24 -24
  14. data/man/uffizzi-connect-docker-hub.ronn +30 -18
  15. data/man/uffizzi-connect-docker-registry +37 -0
  16. data/man/uffizzi-connect-docker-registry.ronn +41 -0
  17. data/man/uffizzi-connect-ecr +27 -25
  18. data/man/uffizzi-connect-ecr.ronn +33 -19
  19. data/man/uffizzi-connect-gcr +20 -29
  20. data/man/uffizzi-connect-gcr.ronn +26 -22
  21. data/man/uffizzi-connect-ghcr +23 -33
  22. data/man/uffizzi-connect-ghcr.ronn +27 -23
  23. data/man/uffizzi-connect.ronn +32 -18
  24. metadata +5 -2
data/man/uffizzi-connect-docker-hub CHANGED
@@ -1,34 +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\-DOCKER\-HUB" "" "May 2022" ""
3
+ .TH "UFFIZZI\-CONNECT\-DOCKER\-HUB" "" "August 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-connect\-docker\-hub\fR \- grant a Uffizzi user account access to a private Docker Hub registry\.
6
6
  .SH "SYNOPSIS"
7
- .nf
8
- uffizzi connect docker\-hub
9
- .fi
7
+ \fBuffizzi connect docker\-hub\fR [\-\-username=USERNAME] [\-\-password=PASSWORD]
10
8
  .SH "DESCRIPTION"
11
- .nf
12
- Given valid credentials, grants a Uffizzi user account access
13
- to a private Docker Hub registry
14
-
15
- This command can fail for the following reasons:
16
- \- The active user does not have permission to connect
17
- external services\.
18
- \- The given credentials are invalid\.
19
-
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
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
- notifications to Uffizzi, see
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
- .fi
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\.
27
31
  .SH "EXAMPLES"
28
- .nf
29
- The following command will prompt the user to enter Docker Hub
30
- credentials, including Docker ID and password or access token:
31
-
32
- $ uffizzi connect docker\-hub
33
- .fi
34
-
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
data/man/uffizzi-connect-docker-hub.ronn CHANGED
@@ -1,27 +1,39 @@
1
- uffizzi-connect-docker-hub - grant a Uffizzi user account access to a private Docker Hub registry.
2
- ================================================================
1
+ # uffizzi-connect-docker-hub - grant a Uffizzi user account access to a private Docker Hub registry.
3
2
 
4
3
  ## SYNOPSIS
5
- uffizzi connect docker-hub
4
+
5
+ `uffizzi connect docker-hub` [--username=USERNAME] [--password=PASSWORD]
6
6
 
7
7
  ## DESCRIPTION
8
- Given valid credentials, grants a Uffizzi user account access
9
- to a private Docker Hub registry
10
8
 
11
- This command can fail for the following reasons:
12
- - The active user does not have permission to connect
13
- external services.
14
- - The given credentials are invalid.
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://github.com/UffizziCloud/uffizzi_cli
15
22
 
16
- For more information on connecting to external services, see:
17
- https://github.com/UffizziCloud/uffizzi_cli
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
- For detailed instructions on configuring webhooks to send push
20
- notifications to Uffizzi, see
21
- https://docs.uffizzi.com/guides/container-registry-integrations
27
+ ## OPTIONS
28
+
29
+ * `-u`, `--username=<username>`:
30
+ Username for the service.
31
+ * `-p`, `--password=<password>`:
32
+ Password for the service.
22
33
 
23
34
  ## EXAMPLES
24
- The following command will prompt the user to enter Docker Hub
25
- credentials, including Docker ID and password or access token:
26
-
27
- $ uffizzi connect docker-hub
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`
data/man/uffizzi-connect-docker-registry ADDED
@@ -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 2022" ""
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://github\.com/UffizziCloud/uffizzi_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
data/man/uffizzi-connect-docker-registry.ronn ADDED
@@ -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://github.com/UffizziCloud/uffizzi_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`
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" "" "May 2022" ""
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
- .nf
8
- uffizzi connect ecr
9
- .fi
7
+ \fBuffizzi connect ecr\fR [\-\-registry=REGISTRY] [\-\-id=ID] [\-\-secret=SECRET]
10
8
  .SH "DESCRIPTION"
11
- .nf
12
- Given valid credentials, grants a Uffizzi user account access
13
- to a private Amazon Elastic Container Registry
14
-
15
- This command can fail for the following reasons:
16
- \- The active user does not have permission to connect
17
- external services\.
18
- \- The given credentials are invalid\.
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
- notifications to Uffizzi, see
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
- .fi
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
- .nf
29
- The following command will prompt the user to enter ACR
30
- credentials, including registry domain, access key ID and
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
data/man/uffizzi-connect-ecr.ronn CHANGED
@@ -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
- uffizzi connect ecr
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
- This command can fail for the following reasons:
12
- - The active user does not have permission to connect
13
- external services.
14
- - The given credentials are invalid.
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
- For more information on connecting to external services, see:
17
- https://github.com/UffizziCloud/uffizzi_cli
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
- For detailed instructions on configuring webhooks to send push
20
- notifications to Uffizzi, see
21
- https://docs.uffizzi.com/guides/container-registry-integrations
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
- The following command will prompt the user to enter ACR
25
- credentials, including registry domain, access key ID and
26
- secret access key:
27
-
28
- $ uffizzi connect ecr
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" "" "May 2022" ""
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
- .nf
8
- uffizzi connect gcr [KEY_FILE]
9
- .fi
7
+ \fBuffizzi connect gcr\fR [KEY_FILE]
10
8
  .SH "DESCRIPTION"
11
- .nf
12
- Given valid credentials, grants a Uffizzi user account access
13
- to a private Google Container Registry
14
-
15
- This command can fail for the following reasons:
16
- \- The active user does not have permission to connect
17
- external services\.
18
- \- The given credentials are invalid\.
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
- notifications to Uffizzi, see
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
- .fi
27
- .SH "POSITIONAL ARGUMENTS"
28
- .nf
24
+ .SH "ARGUMENTS"
25
+ .TP
29
26
  KEY_FILE
30
- A Google Cloud service account key file\. The key file is a
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
- .nf
35
- The following command uses a Google Cloud service account key
36
- file called sa\-private\-key\.json to connect to a private GCR:
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
data/man/uffizzi-connect-gcr.ronn CHANGED
@@ -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
- uffizzi connect gcr [KEY_FILE]
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
- This command can fail for the following reasons:
12
- - The active user does not have permission to connect
13
- external services.
14
- - The given credentials are invalid.
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
- For more information on connecting to external services, see:
17
- https://github.com/UffizziCloud/uffizzi_cli
19
+ For more information on connecting to external services, see:
20
+ https://github.com/UffizziCloud/uffizzi_cli
18
21
 
19
- For detailed instructions on configuring webhooks to send push
20
- notifications to Uffizzi, see
21
- https://docs.uffizzi.com/guides/container-registry-integrations
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
- ## POSITIONAL ARGUMENTS
24
- KEY_FILE
25
- A Google Cloud service account key file. The key file is a
26
- JSON file that grants Uffizzi access to a private GCR.
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
- The following command uses a Google Cloud service account key
30
- file called sa-private-key.json to connect to a private GCR:
31
-
32
- $ uffizzi connect gcr sa-private-key.json
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" "" "July 2022" ""
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
- .nf
8
- uffizzi connect ghcr [OPTION]\|\.\|\.\|\.
9
- .fi
7
+ \fBuffizzi connect ghcr\fR [\-\-username=USERNAME] [\-\-token=TOKEN]
10
8
  .SH "DESCRIPTION"
11
- .nf
12
- Given valid credentials, grants a Uffizzi user account access
13
- to a private GitHub Container Registry\.
14
-
15
- Credentials can be provided interactively or non\-interactively
16
- via command options or environment variables:
17
- GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
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
- notifications to Uffizzi, see
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
- .nf
33
- \-u, \-\-username GitHub username
34
- \-t, \-\-token Personal access token from GitHub
35
- .fi
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
- .nf
38
- The following command will prompt the user to enter GHCR
39
- credentials, including GitHub account name and
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
data/man/uffizzi-connect-ghcr.ronn CHANGED
@@ -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
- uffizzi connect ghcr [OPTION]...
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
- Credentials can be provided interactively or non-interactively
12
- via command options or environment variables:
13
- GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
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
- This command can fail for the following reasons:
16
- - The active user does not have permission to connect
17
- external services.
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
- For more information on connecting to external services, see:
21
- https://github.com/UffizziCloud/uffizzi_cli
20
+ For more information on connecting to external services, see:
21
+ https://github.com/UffizziCloud/uffizzi_cli
22
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
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
- -u, --username GitHub username
29
- -t, --token Personal access token from GitHub
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
- uffizzi connect ghcr
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,31 +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
- uffizzi connect COMMAND
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
- For more information on connecting to external services, see:
11
- https://github.com/UffizziCloud/uffizzi_cli
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
- acr
17
- Connect to Azure Container Registry (azurecr.io).
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).
18
35
 
19
- docker-hub
20
- Connect to Docker Hub (hub.docker.com).
21
36
 
22
- ecr
23
- Connect to Amazon Elastic Container Registry (amazonaws.com).
37
+ ## FLAGS
24
38
 
25
- gcr
26
- Connect to Google Container Registry (gcr.io).
39
+ * `--skip-raise-existence-error`:
40
+ If credential exists, do not raise an exception, just print a message.
27
41
 
28
- ghcr
29
- Connect to GitHub Container Registry (ghcr.io).
42
+ * `--update-credential-if-exists`:
43
+ Update credential if it exists.
30
44
 
31
- Run 'uffizzi connect COMMAND --help' for more information on a command.
45
+ Run `uffizzi connect COMMAND --help` for more information on a command.