uffizzi-cli 0.11.4 → 0.14.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.
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Uffizzi
4
+ module ConnectHelper
5
+ class << self
6
+ def get_docker_registry_data(options)
7
+ registry_url = options[:registry] || ENV['DOCKER_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
8
+ username = options[:username] || ENV['DOCKER_REGISTRY_USERNAME'] || Uffizzi.ui.ask('Username:')
9
+ password = options[:password] || ENV['DOCKER_REGISTRY_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
10
+
11
+ [registry_url, username, password]
12
+ end
13
+
14
+ def get_docker_hub_data(options)
15
+ username = options[:username] || ENV['DOCKERHUB_USERNAME'] || Uffizzi.ui.ask('Username:')
16
+ password = options[:password] || ENV['DOCKERHUB_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
17
+
18
+ [username, password]
19
+ end
20
+
21
+ def get_acr_data(options)
22
+ registry_url = options[:registry] || ENV['ACR_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
23
+ username = options[:username] || ENV['ACR_USERNAME'] || Uffizzi.ui.ask('Docker ID:')
24
+ password = options[:password] || ENV['ACR_PASSWORD'] || Uffizzi.ui.ask('Password/Access Token:', echo: false)
25
+
26
+ [registry_url, username, password]
27
+ end
28
+
29
+ def get_ecr_data(options)
30
+ registry_url = options[:registry] || ENV['AWS_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
31
+ access_key_id = options[:id] || ENV['AWS_ACCESS_KEY_ID'] || Uffizzi.ui.ask('Access key ID:')
32
+ secret_access_key = options[:secret] || ENV['AWS_SECRET_ACCESS_KEY'] || Uffizzi.ui.ask('Secret access key:', echo: false)
33
+
34
+ [registry_url, access_key_id, secret_access_key]
35
+ end
36
+
37
+ def get_ghcr_data(options)
38
+ username = options[:username] || ENV['GITHUB_USERNAME'] || Uffizzi.ui.ask('Github Username:')
39
+ password = options[:token] || ENV['GITHUB_ACCESS_TOKEN'] || Uffizzi.ui.ask('Access Token:', echo: false)
40
+
41
+ [username, password]
42
+ end
43
+ end
44
+ end
45
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Uffizzi
4
- VERSION = '0.11.4'
4
+ VERSION = '0.14.0'
5
5
  end
data/man/uffizzi-connect CHANGED
@@ -1,37 +1,42 @@
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" "" "July 2022" ""
3
+ .TH "UFFIZZI\-CONNECT" "" "August 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-connect\fR \- grant a Uffizzi user account access to external services
6
6
  .SH "SYNOPSIS"
7
- .nf
8
- uffizzi connect COMMAND
9
- .fi
7
+ \fBuffizzi connect\fR COMMAND [\-\-skip\-raise\-existence\-error] [\-\-update\-credential\-if\-exists]
10
8
  .SH "DESCRIPTION"
11
- .nf
12
- Grants a Uffizzi user account access to external services
13
-
9
+ Grants a Uffizzi user account access to external services\.
10
+ .P
14
11
  For more information on connecting to external services, see:
12
+ .br
15
13
  https://github\.com/UffizziCloud/uffizzi_cli
16
- .fi
17
14
  .SH "COMMANDS"
18
- .nf
19
15
  COMMAND is one of the following:
20
-
21
- acr
22
- Connect to Azure Container Registry (azurecr\.io)\.
23
-
24
- docker\-hub
25
- Connect to Docker Hub (hub\.docker\.com)\.
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
- .fi
16
+ .TP
17
+ \fBacr\fR
18
+ Connect to Azure Container Registry (azurecr\.io)\.
19
+ .TP
20
+ \fBdocker\-hub\fR
21
+ Connect to Docker Hub (hub\.docker\.com)\.
22
+ .TP
23
+ \fBdocker\-registry\fR
24
+ Connect to any registry implementing the Docker Registry HTTP API protocol
25
+ .TP
26
+ \fBecr\fR
27
+ Connect to Amazon Elastic Container Registry (amazonaws\.com)\.
28
+ .TP
29
+ \fBgcr\fR
30
+ Connect to Google Container Registry (gcr\.io)\.
31
+ .TP
32
+ \fBghcr\fR
33
+ Connect to GitHub Container Registry (ghcr\.io)\.
34
+ .SH "FLAGS"
35
+ .TP
36
+ \fB\-\-skip\-raise\-existence\-error\fR
37
+ If credential exists, do not raise an exception, just print a message\.
38
+ .TP
39
+ \fB\-\-update\-credential\-if\-exists\fR
40
+ Update credential if it exists\.
36
41
  .P
37
- Run \'uffizzi connect COMMAND \-\-help\' for more information on a command\.
42
+ Run \fBuffizzi connect COMMAND \-\-help\fR for more information on a command\.
@@ -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\-ACR" "" "May 2022" ""
3
+ .TH "UFFIZZI\-CONNECT\-ACR" "" "August 2022" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-connect\-acr\fR \- grant a Uffizzi user account access to a private Azure Container Registry (ACR)
6
6
  .SH "SYNOPSIS"
7
- .nf
8
- uffizzi connect acr
9
- .fi
7
+ \fBuffizzi connect acr\fR [\-\-registry=REGISTRY] [\-\-username=USERNAME] [\-\-password=PASSWORD]
10
8
  .SH "DESCRIPTION"
11
- .nf
12
- Given valid credentials, grants a Uffizzi user account access
13
- to a private Azure 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 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
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\-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\.
27
34
  .SH "EXAMPLES"
28
- .nf
29
- The following command will prompt the user to enter ACR
30
- credentials, including registry domain, Docker ID and
31
- password or access token:
32
-
33
- $ uffizzi connect acr
34
- .fi
35
-
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
@@ -1,28 +1,42 @@
1
- uffizzi-connect-acr - grant a Uffizzi user account access to a private Azure Container Registry (ACR)
2
- ================================================================
1
+ # uffizzi-connect-acr - grant a Uffizzi user account access to a private Azure Container Registry (ACR)
3
2
 
4
3
  ## SYNOPSIS
5
- uffizzi connect acr
4
+
5
+ `uffizzi connect acr` [--registry=REGISTRY] [--username=USERNAME] [--password=PASSWORD]
6
6
 
7
7
  ## DESCRIPTION
8
- Given valid credentials, grants a Uffizzi user account access
9
- to a private Azure 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 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://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
+ * `-u`, `--username=<username>`:
32
+ Username for the service.
33
+ * `-p`, `--password=<password>`:
34
+ Password for the service.
22
35
 
23
36
  ## EXAMPLES
24
- The following command will prompt the user to enter ACR
25
- credentials, including registry domain, Docker ID and
26
- password or access token:
27
-
28
- $ uffizzi connect acr
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`
@@ -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
@@ -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`
@@ -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
@@ -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`
@@ -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
@@ -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`
@@ -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