uffizzi-cli 0.11.5 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/config/uffizzi.rb +1 -0
  3. data/lib/uffizzi/cli/connect.rb +95 -46
  4. data/lib/uffizzi/cli/disconnect.rb +5 -2
  5. data/lib/uffizzi/cli/login.rb +11 -6
  6. data/lib/uffizzi/cli/login_by_identity_token.rb +47 -0
  7. data/lib/uffizzi/cli/preview.rb +95 -34
  8. data/lib/uffizzi/cli/project.rb +3 -1
  9. data/lib/uffizzi/cli.rb +8 -0
  10. data/lib/uffizzi/clients/api/api_client.rb +21 -14
  11. data/lib/uffizzi/clients/api/api_routes.rb +18 -8
  12. data/lib/uffizzi/clients/api/http_client.rb +4 -4
  13. data/lib/uffizzi/helpers/connect_helper.rb +45 -0
  14. data/lib/uffizzi/services/project_service.rb +1 -0
  15. data/lib/uffizzi/version.rb +1 -1
  16. data/man/uffizzi-connect +30 -31
  17. data/man/uffizzi-connect-acr +27 -25
  18. data/man/uffizzi-connect-acr.ronn +33 -19
  19. data/man/uffizzi-connect-docker-hub +24 -24
  20. data/man/uffizzi-connect-docker-hub.ronn +30 -18
  21. data/man/uffizzi-connect-docker-registry +37 -0
  22. data/man/uffizzi-connect-docker-registry.ronn +41 -0
  23. data/man/uffizzi-connect-ecr +27 -25
  24. data/man/uffizzi-connect-ecr.ronn +33 -19
  25. data/man/uffizzi-connect-gcr +20 -29
  26. data/man/uffizzi-connect-gcr.ronn +26 -22
  27. data/man/uffizzi-connect-ghcr +23 -33
  28. data/man/uffizzi-connect-ghcr.ronn +27 -23
  29. data/man/uffizzi-connect.ronn +28 -20
  30. data/man/uffizzi-login-by-identity-token +29 -0
  31. data/man/uffizzi-login-by-identity-token.html +106 -0
  32. data/man/uffizzi-login-by-identity-token.ronn +21 -0
  33. data/man/uffizzi-preview-create +16 -1
  34. data/man/uffizzi-preview-create.ronn +14 -0
  35. data/man/uffizzi-preview-list +25 -1
  36. data/man/uffizzi-preview-list.ronn +23 -0
  37. data/man/uffizzi-preview-update +20 -2
  38. data/man/uffizzi-preview-update.ronn +17 -0
  39. metadata +9 -2
data/lib/uffizzi/cli.rb CHANGED
@@ -24,6 +24,14 @@ module Uffizzi
24
24
  Login.new(options).run
25
25
  end
26
26
 
27
+ desc 'login_by_identity_token [OPTIONS]', 'Login or register to Uffizzi to view and manage your previews'
28
+ method_option :server, required: true, aliases: '-s'
29
+ method_option :token, required: true, aliases: '-t'
30
+ def login_by_identity_token
31
+ require_relative 'cli/login_by_identity_token'
32
+ LoginByIdentityToken.new(options).run
33
+ end
34
+
27
35
  desc 'logout', 'Log out of a Uffizzi user account'
28
36
  def logout
29
37
  require_relative 'cli/logout'
@@ -13,6 +13,13 @@ module ApiClient
13
13
  build_response(response)
14
14
  end
15
15
 
16
+ def create_ci_session(server, params = {})
17
+ uri = ci_session_uri(server)
18
+ response = http_client.make_post_request(uri, params)
19
+
20
+ build_response(response)
21
+ end
22
+
16
23
  def destroy_session(server)
17
24
  uri = session_uri(server)
18
25
  response = http_client.make_delete_request(uri)
@@ -27,16 +34,16 @@ module ApiClient
27
34
  build_response(response)
28
35
  end
29
36
 
30
- def fetch_credentials(server)
31
- uri = credentials_uri(server)
37
+ def fetch_credentials(server, account_id)
38
+ uri = credentials_uri(server, account_id)
32
39
 
33
40
  response = http_client.make_get_request(uri)
34
41
 
35
42
  build_response(response)
36
43
  end
37
44
 
38
- def check_credential(server, type)
39
- uri = check_credential_uri(server, type)
45
+ def check_credential(server, account_id, type)
46
+ uri = check_credential_uri(server, account_id, type)
40
47
  response = http_client.make_get_request(uri)
41
48
 
42
49
  build_response(response)
@@ -49,8 +56,8 @@ module ApiClient
49
56
  build_response(response)
50
57
  end
51
58
 
52
- def create_project(server, params)
53
- uri = projects_uri(server)
59
+ def create_project(server, account_id, params)
60
+ uri = create_projects_uri(server, account_id)
54
61
  response = http_client.make_post_request(uri, params)
55
62
 
56
63
  build_response(response)
@@ -63,15 +70,15 @@ module ApiClient
63
70
  build_response(response)
64
71
  end
65
72
 
66
- def create_credential(server, params)
67
- uri = credentials_uri(server)
73
+ def create_credential(server, account_id, params)
74
+ uri = credentials_uri(server, account_id)
68
75
  response = http_client.make_post_request(uri, params)
69
76
 
70
77
  build_response(response)
71
78
  end
72
79
 
73
- def update_credential(server, params, type)
74
- uri = credential_uri(server, type)
80
+ def update_credential(server, account_id, params, type)
81
+ uri = credential_uri(server, account_id, type)
75
82
  response = http_client.make_put_request(uri, params)
76
83
 
77
84
  build_response(response)
@@ -84,8 +91,8 @@ module ApiClient
84
91
  build_response(response)
85
92
  end
86
93
 
87
- def delete_credential(server, credential_type)
88
- uri = credential_uri(server, credential_type)
94
+ def delete_credential(server, account_id, credential_type)
95
+ uri = credential_uri(server, account_id, credential_type)
89
96
  response = http_client.make_delete_request(uri)
90
97
 
91
98
  build_response(response)
@@ -147,8 +154,8 @@ module ApiClient
147
154
  build_response(response)
148
155
  end
149
156
 
150
- def fetch_deployments(server, project_slug)
151
- uri = deployments_uri(server, project_slug)
157
+ def fetch_deployments(server, project_slug, filter)
158
+ uri = deployments_uri(server, project_slug, filter)
152
159
  response = http_client.make_get_request(uri)
153
160
 
154
161
  build_response(response)
@@ -15,6 +15,10 @@ module ApiRoutes
15
15
  "#{server}/api/cli/v1/projects"
16
16
  end
17
17
 
18
+ def create_projects_uri(server, account_id)
19
+ "#{server}/api/cli/v1/accounts/#{account_id}/projects"
20
+ end
21
+
18
22
  def secret_uri(server, project_slug, id)
19
23
  path_id = CGI.escape(id)
20
24
  "#{server}/api/cli/v1/projects/#{project_slug}/secrets/#{path_id}"
@@ -28,12 +32,18 @@ module ApiRoutes
28
32
  "#{server}/api/cli/v1/session"
29
33
  end
30
34
 
35
+ def ci_session_uri(server)
36
+ "#{server}/api/cli/v1/ci/session"
37
+ end
38
+
31
39
  def validate_compose_file_uri(server, project_slug)
32
40
  "#{compose_files_uri(server, project_slug)}/validate"
33
41
  end
34
42
 
35
- def deployments_uri(server, project_slug)
36
- "#{server}/api/cli/v1/projects/#{project_slug}/deployments"
43
+ def deployments_uri(server, project_slug, filter = nil)
44
+ return "#{server}/api/cli/v1/projects/#{project_slug}/deployments" if filter.nil?
45
+
46
+ "#{server}/api/cli/v1/projects/#{project_slug}/deployments?q=#{filter.to_json}"
37
47
  end
38
48
 
39
49
  def deployment_uri(server, project_slug, deployment_id)
@@ -52,20 +62,20 @@ module ApiRoutes
52
62
  "#{server}/api/cli/v1/projects/#{project_slug}/deployments/#{deployment_id}/events"
53
63
  end
54
64
 
55
- def check_credential_uri(server, type)
56
- "#{server}/api/cli/v1/account/credentials/#{type}/check_credential"
65
+ def check_credential_uri(server, account_id, type)
66
+ "#{server}/api/cli/v1/accounts/#{account_id}/credentials/#{type}/check_credential"
57
67
  end
58
68
 
59
- def credentials_uri(server)
60
- "#{server}/api/cli/v1/account/credentials"
69
+ def credentials_uri(server, account_id)
70
+ "#{server}/api/cli/v1/accounts/#{account_id}/credentials"
61
71
  end
62
72
 
63
73
  def preview_services_uri(server, project_slug, deployment_id)
64
74
  "#{server}/api/cli/v1/projects/#{project_slug}/deployments/#{deployment_id}/containers"
65
75
  end
66
76
 
67
- def credential_uri(server, credential_type)
68
- "#{server}/api/cli/v1/account/credentials/#{credential_type}"
77
+ def credential_uri(server, account_id, credential_type)
78
+ "#{server}/api/cli/v1/accounts/#{account_id}/credentials/#{credential_type}"
69
79
  end
70
80
 
71
81
  def preview_service_logs_uri(server, project_slug, deployment_id, container_name)
@@ -50,13 +50,13 @@ module Uffizzi
50
50
  headers = { 'Content-Type' => 'application/json' }
51
51
  request = case method
52
52
  when :get
53
- Net::HTTP::Get.new(uri.path, headers)
53
+ Net::HTTP::Get.new(uri.request_uri, headers)
54
54
  when :post
55
- Net::HTTP::Post.new(uri.path, headers)
55
+ Net::HTTP::Post.new(uri.request_uri, headers)
56
56
  when :delete
57
- Net::HTTP::Delete.new(uri.path, headers)
57
+ Net::HTTP::Delete.new(uri.request_uri, headers)
58
58
  when :put
59
- Net::HTTP::Put.new(uri.path, headers)
59
+ Net::HTTP::Put.new(uri.request_uri, headers)
60
60
  end
61
61
  if request.instance_of?(Net::HTTP::Post) || request.instance_of?(Net::HTTP::Put)
62
62
  request.body = params.to_json
@@ -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
@@ -24,6 +24,7 @@ class ProjectService
24
24
  Uffizzi.ui.say("Project name: #{project[:name]}")
25
25
  Uffizzi.ui.say("Project slug: #{project[:slug]}")
26
26
  Uffizzi.ui.say("Description: #{project[:description]}".strip)
27
+ Uffizzi.ui.say("Account name: #{project[:account][:name]}".strip)
27
28
  Uffizzi.ui.say("Created: #{project[:created_at]}")
28
29
  default_compose = project[:default_compose].nil? ? nil : project[:default_compose][:source]
29
30
  Uffizzi.ui.say("Default compose: #{default_compose}".strip)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Uffizzi
4
- VERSION = '0.11.5'
4
+ VERSION = '1.0.0'
5
5
  end
data/man/uffizzi-connect CHANGED
@@ -1,43 +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)\.
36
34
  .SH "FLAGS"
37
- .nf
38
- \-\-skip\-raise\-existence\-error If credential exist, do not raise an exception, just print a message
39
-
40
- \-\-update\-credential\-if\-exists Update credential if it exists
41
- .fi
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\.
42
41
  .P
43
- 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`