uffizzi-cli 0.11.5 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a81fa2bb6f00491f6c59e4c10ea3ce067da1b75b26ff8543e1a08558893058c0
-  data.tar.gz: fec82e0d04c499515f0221740a1a40b51bd5593a35223c0a7723648f20b25a5e
+  metadata.gz: c27a1f65cd69d407dc2f086733a20baaf6e129b7433322ac61682f6b8a1fa54e
+  data.tar.gz: 61c6860dbc035009ee6197f353c05d0af95eda6d6f77b67d25f672ba954e114f
 SHA512:
-  metadata.gz: 82610a6fe745521646e7d7e7c5e0f65a39263ea53987f1e431d0a0d0b69033d015a67bcd48b07e30c5d044f2167c752f307525438ca232044e90c5b60eb0f602
-  data.tar.gz: 67d5b6c3947e01e72c3ec678b6b14a1ccc6b78583d34f46274cdfa1f7692c9632b98728f43bf1ab5e0b3e984313db98e536c5231ddb9d2a07cc8156b8334ca2e
+  metadata.gz: 709d000e6701f32d3dcaa3745c68d2eb63695dba2dd8ef939201569605bb121fdd3422d730d3bdc2687a33cc81810b97a3a4f4841187aac68547824293523173
+  data.tar.gz: 1b0ae241adab3fb770f25cca8709ae779b5c8de16056fa71e6242d470123550b6cacc920f1e2b9474951323b72d1d18160a840ed64c4814469eb89e138d0c3d5

data/config/uffizzi.rb

@@ -19,6 +19,7 @@ module Uffizzi
       google: 'UffizziCore::Credential::Google',
       amazon: 'UffizziCore::Credential::Amazon',
       github_registry: 'UffizziCore::Credential::GithubContainerRegistry',
+      docker_registry: 'UffizziCore::Credential::DockerRegistry',
     }
     config.default_server = 'app.uffizzi.com'
   end

data/lib/uffizzi/cli/connect.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'uffizzi'
+require 'uffizzi/helpers/connect_helper'
 
 module Uffizzi
   class Cli::Connect < Thor
@@ -21,42 +22,75 @@ module Uffizzi
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
     method_option :update_credential_if_exists, type: :boolean, default: false
+    method_option :username, type: :string, aliases: :u
+    method_option :password, type: :string, aliases: :p
     def docker_hub
       type = Uffizzi.configuration.credential_types[:dockerhub]
       credential_exists = credential_exists?(type)
       handle_existing_credential_options('docker-hub') if credential_exists
 
-      username = ENV['DOCKERHUB_USERNAME'] || Uffizzi.ui.ask('Username:')
-      password = ENV['DOCKERHUB_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
+      username, password = Uffizzi::ConnectHelper.get_docker_hub_data(options)
 
       params = {
         username: username,
         password: password,
         type: type,
       }
+      server = ConfigFile.read_option(:server)
+
+      response = if credential_exists
+        update_credential(server, params, type)
+      else
+        create_credential(server, params)
+      end
+
+      handle_result_for('Docker Hub', response)
+    end
+
+    desc 'docker-registry', 'Connect to any registry implementing the Docker Registry HTTP API protocol'
+    method_option :skip_raise_existence_error, type: :boolean, default: false,
+                                               desc: 'Skip raising an error within check the credential'
+    method_option :update_credential_if_exists, type: :boolean, default: false
+    method_option :registry, type: :string, aliases: :r
+    method_option :username, type: :string, aliases: :u
+    method_option :password, type: :string, aliases: :p
+    def docker_registry
+      type = Uffizzi.configuration.credential_types[:docker_registry]
+      credential_exists = credential_exists?(type)
+      handle_existing_credential_options('docker-registry') if credential_exists
 
+      registry_url, username, password = Uffizzi::ConnectHelper.get_docker_registry_data(options)
+
+      params = {
+        registry_url: prepare_registry_url(registry_url),
+        username: username,
+        password: password,
+        type: type,
+      }
       server = ConfigFile.read_option(:server)
-      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if successful?(response)
-        print_success_message('Docker Hub')
+      response = if credential_exists
+        update_credential(server, params, type)
       else
-        ResponseHelper.handle_failed_response(response)
+        create_credential(server, params)
       end
+
+      handle_result_for('Docker Registry', response)
     end
 
     desc 'acr', 'Connect to Azure Container Registry (azurecr.io)'
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
     method_option :update_credential_if_exists, type: :boolean, default: false
+    method_option :registry, type: :string, aliases: :r
+    method_option :username, type: :string, aliases: :u
+    method_option :password, type: :string, aliases: :p
     def acr
       type = Uffizzi.configuration.credential_types[:azure]
       credential_exists = credential_exists?(type)
       handle_existing_credential_options('acr') if credential_exists
 
-      registry_url = ENV['ACR_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
-      username = ENV['ACR_USERNAME'] || Uffizzi.ui.ask('Docker ID:')
-      password = ENV['ACR_PASSWORD'] || Uffizzi.ui.ask('Password/Access Token:', echo: false)
+      registry_url, username, password = Uffizzi::ConnectHelper.get_acr_data(options)
 
       params = {
         username: username,
@@ -64,45 +98,46 @@ module Uffizzi
         registry_url: prepare_registry_url(registry_url),
         type: type,
       }
-
       server = ConfigFile.read_option(:server)
-      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if successful?(response)
-        print_success_message('ACR')
+      response = if credential_exists
+        update_credential(server, params, type)
       else
-        ResponseHelper.handle_failed_response(response)
+        create_credential(server, params)
       end
+
+      handle_result_for('ACR', response)
     end
 
     desc 'ecr', 'Connect to Amazon Elastic Container Registry'
     method_option :skip_raise_existence_error, type: :boolean, default: false,
                                                desc: 'Skip raising an error within check the credential'
     method_option :update_credential_if_exists, type: :boolean, default: false
+    method_option :registry, type: :string, aliases: :r
+    method_option :id, type: :string
+    method_option :secret, type: :string, aliases: :s
     def ecr
       type = Uffizzi.configuration.credential_types[:amazon]
       credential_exists = credential_exists?(type)
       handle_existing_credential_options('ecr') if credential_exists
 
-      registry_url = ENV['AWS_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
-      access_key = ENV['AWS_ACCESS_KEY_ID'] || Uffizzi.ui.ask('Access key ID:')
-      secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || Uffizzi.ui.ask('Secret access key:', echo: false)
+      registry_url, access_key_id, secret_access_key = Uffizzi::ConnectHelper.get_ecr_data(options)
 
       params = {
-        username: access_key,
+        username: access_key_id,
         password: secret_access_key,
         registry_url: prepare_registry_url(registry_url),
         type: type,
       }
-
       server = ConfigFile.read_option(:server)
-      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if successful?(response)
-        print_success_message('ECR')
+      response = if credential_exists
+        update_credential(server, params, type)
       else
-        ResponseHelper.handle_failed_response(response)
+        create_credential(server, params)
       end
+
+      handle_result_for('ECR', response)
     end
 
     desc 'gcr', 'Connect to Google Container Registry (gcr.io)'
@@ -120,15 +155,15 @@ module Uffizzi
         password: credential_content,
         type: type,
       }
-
       server = ConfigFile.read_option(:server)
-      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if successful?(response)
-        print_success_message('GCR')
+      response = if credential_exists
+        update_credential(server, params, type)
       else
-        ResponseHelper.handle_failed_response(response)
+        create_credential(server, params)
       end
+
+      handle_result_for('GCR', response)
     end
 
     desc 'ghcr', 'Connect to GitHub Container Registry (ghcr.io)'
@@ -142,32 +177,36 @@ module Uffizzi
       credential_exists = credential_exists?(type)
       handle_existing_credential_options('ghcr') if credential_exists
 
-      username = options[:username] || ENV['GITHUB_USERNAME'] || Uffizzi.ui.ask('Github Username:')
-      password = options[:token] || ENV['GITHUB_ACCESS_TOKEN'] || Uffizzi.ui.ask('Access Token:', echo: false)
+      username, password = Uffizzi::ConnectHelper.get_ghcr_data(options)
 
       params = {
         username: username,
         password: password,
         type: type,
       }
-
       server = ConfigFile.read_option(:server)
-      response = create_or_update_credential(server, params, create: !credential_exists)
 
-      if successful?(response)
-        print_success_message('GHCR')
+      response = if credential_exists
+        update_credential(server, params, type)
       else
-        ResponseHelper.handle_failed_response(response)
+        create_credential(server, params)
       end
+
+      handle_result_for('GHCR', response)
     end
 
     map 'list-credentials' => 'list_credentials'
     map 'docker-hub' => 'docker_hub'
+    map 'docker-registry' => 'docker_registry'
 
     private
 
-    def successful?(response)
-      ResponseHelper.created?(response) || ResponseHelper.ok?(response)
+    def handle_result_for(credential_type, response)
+      if ResponseHelper.created?(response) || ResponseHelper.ok?(response)
+        print_success_message(credential_type)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
     end
 
     def prepare_registry_url(registry_url)
@@ -176,8 +215,8 @@ module Uffizzi
       "https://#{registry_url}"
     end
 
-    def print_success_message(credential_type_slug)
-      Uffizzi.ui.say("Successfully connected to #{credential_type_slug}.")
+    def print_success_message(credential_type)
+      Uffizzi.ui.say("Successfully connected to #{credential_type}.")
     end
 
     def credential_exists?(type)
@@ -202,10 +241,6 @@ module Uffizzi
       end
     end
 
-    def create_or_update_credential(server, params, create: true)
-      create ? create_credential(server, params) : update_credential(server, params, params[:type])
-    end
-
     def handle_list_credentials_success(response)
       credentials = response[:body][:credentials]
       credentials.each do |credential|

data/lib/uffizzi/cli/disconnect.rb

@@ -10,6 +10,8 @@ module Uffizzi
       connection_type = case credential_type
                         when 'docker-hub'
                           Uffizzi.configuration.credential_types[:dockerhub]
+                        when 'docker-registry'
+                          Uffizzi.configuration.credential_types[:docker_registry]
                         when 'acr'
                           Uffizzi.configuration.credential_types[:azure]
                         when 'ecr'
@@ -25,7 +27,7 @@ module Uffizzi
       response = delete_credential(ConfigFile.read_option(:server), connection_type)
 
       if ResponseHelper.no_content?(response)
-        Uffizzi.ui.say("Successfully disconnected #{connection_name(credential_type)} connection")
+        Uffizzi.ui.say("Successfully disconnected from #{connection_name(credential_type)}.")
       else
         ResponseHelper.handle_failed_response(response)
       end
@@ -36,6 +38,7 @@ module Uffizzi
     def connection_name(credential_type)
       {
         'docker-hub' => 'DockerHub',
+        'docker-registry' => 'Docker Registry',
         'acr' => 'ACR',
         'ecr' => 'ECR',
         'gcr' => 'GCR',

data/lib/uffizzi/helpers/connect_helper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Uffizzi
+  module ConnectHelper
+    class << self
+      def get_docker_registry_data(options)
+        registry_url = options[:registry] || ENV['DOCKER_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
+        username = options[:username] || ENV['DOCKER_REGISTRY_USERNAME'] || Uffizzi.ui.ask('Username:')
+        password = options[:password] || ENV['DOCKER_REGISTRY_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
+
+        [registry_url, username, password]
+      end
+
+      def get_docker_hub_data(options)
+        username = options[:username] || ENV['DOCKERHUB_USERNAME'] || Uffizzi.ui.ask('Username:')
+        password = options[:password] || ENV['DOCKERHUB_PASSWORD'] || Uffizzi.ui.ask('Password:', echo: false)
+
+        [username, password]
+      end
+
+      def get_acr_data(options)
+        registry_url = options[:registry] || ENV['ACR_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
+        username = options[:username] || ENV['ACR_USERNAME'] || Uffizzi.ui.ask('Docker ID:')
+        password = options[:password] || ENV['ACR_PASSWORD'] || Uffizzi.ui.ask('Password/Access Token:', echo: false)
+
+        [registry_url, username, password]
+      end
+
+      def get_ecr_data(options)
+        registry_url = options[:registry] || ENV['AWS_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain:')
+        access_key_id = options[:id] || ENV['AWS_ACCESS_KEY_ID'] || Uffizzi.ui.ask('Access key ID:')
+        secret_access_key = options[:secret] || ENV['AWS_SECRET_ACCESS_KEY'] || Uffizzi.ui.ask('Secret access key:', echo: false)
+
+        [registry_url, access_key_id, secret_access_key]
+      end
+
+      def get_ghcr_data(options)
+        username = options[:username] || ENV['GITHUB_USERNAME'] || Uffizzi.ui.ask('Github Username:')
+        password = options[:token] || ENV['GITHUB_ACCESS_TOKEN'] || Uffizzi.ui.ask('Access Token:', echo: false)
+
+        [username, password]
+      end
+    end
+  end
+end

data/lib/uffizzi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uffizzi
-  VERSION = '0.11.5'
+  VERSION = '0.12.0'
 end

data/man/uffizzi-connect

@@ -1,43 +1,42 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT" "" "July 2022" ""
+.TH "UFFIZZI\-CONNECT" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\fR \- grant a Uffizzi user account access to external services
 .SH "SYNOPSIS"
-.nf
-uffizzi connect COMMAND
-.fi
+\fBuffizzi connect\fR COMMAND [\-\-skip\-raise\-existence\-error] [\-\-update\-credential\-if\-exists]
 .SH "DESCRIPTION"
-.nf
-Grants a Uffizzi user account access to external services
-
+Grants a Uffizzi user account access to external services\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-.fi
 .SH "COMMANDS"
-.nf
 COMMAND is one of the following:
-
-acr
-    Connect to Azure Container Registry (azurecr\.io)\.
-
-docker\-hub
-    Connect to Docker Hub (hub\.docker\.com)\.
-
-ecr
-    Connect to Amazon Elastic Container Registry (amazonaws\.com)\.
-
-gcr
-    Connect to Google Container Registry (gcr\.io)\.
-
-ghcr
-    Connect to GitHub Container Registry (ghcr\.io)\.
-.fi
+.TP
+\fBacr\fR
+Connect to Azure Container Registry (azurecr\.io)\.
+.TP
+\fBdocker\-hub\fR
+Connect to Docker Hub (hub\.docker\.com)\.
+.TP
+\fBdocker\-registry\fR
+Connect to any registry implementing the Docker Registry HTTP API protocol
+.TP
+\fBecr\fR
+Connect to Amazon Elastic Container Registry (amazonaws\.com)\.
+.TP
+\fBgcr\fR
+Connect to Google Container Registry (gcr\.io)\.
+.TP
+\fBghcr\fR
+Connect to GitHub Container Registry (ghcr\.io)\.
 .SH "FLAGS"
-.nf
-\-\-skip\-raise\-existence\-error        If credential exist, do not raise an exception, just print a message
-
-\-\-update\-credential\-if\-exists       Update credential if it exists
-.fi
+.TP
+\fB\-\-skip\-raise\-existence\-error\fR
+If credential exists, do not raise an exception, just print a message\.
+.TP
+\fB\-\-update\-credential\-if\-exists\fR
+Update credential if it exists\.
 .P
-Run \'uffizzi connect COMMAND \-\-help\' for more information on a command\.
+Run \fBuffizzi connect COMMAND \-\-help\fR for more information on a command\.

data/man/uffizzi-connect-acr

@@ -1,35 +1,37 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-ACR" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT\-ACR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-acr\fR \- grant a Uffizzi user account access to a private Azure Container Registry (ACR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect acr
-.fi
+\fBuffizzi connect acr\fR [\-\-registry=REGISTRY] [\-\-username=USERNAME] [\-\-password=PASSWORD]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private Azure Container Registry
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private Azure Container Registry
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBACR_REGISTRY_URL\fR, \fBACR_REGISTRY_USERNAME\fR, \fBACR_REGISTRY_PASSWORD\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
+.SH "OPTIONS"
+.TP
+\fB\-r\fR, \fB\-\-registry=<registry>\fR
+URL of the service\.
+.TP
+\fB\-u\fR, \fB\-\-username=<username>\fR
+Username for the service\.
+.TP
+\fB\-p\fR, \fB\-\-password=<password>\fR
+Password for the service\.
 .SH "EXAMPLES"
-.nf
-The following command will prompt the user to enter ACR
-credentials, including registry domain, Docker ID and
-password or access token:
-
-    $ uffizzi connect acr
-.fi
-
+The following command will prompt the user to enter ACR credentials, including registry domain, Docker ID and password or access token:
+.P
+\fBuffizzi connect acr\fR

data/man/uffizzi-connect-acr.ronn

@@ -1,28 +1,42 @@
-uffizzi-connect-acr - grant a Uffizzi user account access to a private Azure Container Registry (ACR)
-================================================================
+# uffizzi-connect-acr - grant a Uffizzi user account access to a private Azure Container Registry (ACR)
 
 ## SYNOPSIS
-    uffizzi connect acr
+
+`uffizzi connect acr` [--registry=REGISTRY] [--username=USERNAME] [--password=PASSWORD]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private Azure Container Registry
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect 
-          external services.
-        - The given credentials are invalid.
+Given valid credentials, grants a Uffizzi user account access 
+to a private Azure Container Registry
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`ACR_REGISTRY_URL`, `ACR_REGISTRY_USERNAME`, `ACR_REGISTRY_PASSWORD`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
-    https://docs.uffizzi.com/guides/container-registry-integrations
+## OPTIONS
+
+* `-r`, `--registry=<registry>`:
+  URL of the service.
+* `-u`, `--username=<username>`:
+  Username for the service.
+* `-p`, `--password=<password>`:
+  Password for the service.
 
 ## EXAMPLES
-    The following command will prompt the user to enter ACR 
-    credentials, including registry domain, Docker ID and 
-    password or access token:
-          
-        $ uffizzi connect acr
+
+The following command will prompt the user to enter ACR 
+credentials, including registry domain, Docker ID and 
+password or access token:
+
+`uffizzi connect acr`

data/man/uffizzi-connect-docker-hub

@@ -1,34 +1,34 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-DOCKER\-HUB" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT\-DOCKER\-HUB" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-docker\-hub\fR \- grant a Uffizzi user account access to a private Docker Hub registry\.
 .SH "SYNOPSIS"
-.nf
-uffizzi connect docker\-hub
-.fi
+\fBuffizzi connect docker\-hub\fR [\-\-username=USERNAME] [\-\-password=PASSWORD]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private Docker Hub registry
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private Docker Hub registry
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBDOCKERHUB_USERNAME\fR, \fBDOCKERHUB_PASSWORD\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
+.SH "OPTIONS"
+.TP
+\fB\-u\fR, \fB\-\-username=<username>\fR
+Username for the service\.
+.TP
+\fB\-p\fR, \fB\-\-password=<password>\fR
+Password for the service\.
 .SH "EXAMPLES"
-.nf
-The following command will prompt the user to enter Docker Hub
-credentials, including Docker ID and password or access token:
-
-    $ uffizzi connect docker\-hub
-.fi
-
+The following command will prompt the user to enter Docker Hub credentials, including Docker ID and password or access token:
+.P
+\fBuffizzi connect docker\-hub\fR

data/man/uffizzi-connect-docker-hub.ronn

@@ -1,27 +1,39 @@
-uffizzi-connect-docker-hub - grant a Uffizzi user account access to a private Docker Hub registry.
-================================================================
+# uffizzi-connect-docker-hub - grant a Uffizzi user account access to a private Docker Hub registry.
 
 ## SYNOPSIS
-    uffizzi connect docker-hub
+
+`uffizzi connect docker-hub` [--username=USERNAME] [--password=PASSWORD]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private Docker Hub registry
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect 
-          external services.
-        - The given credentials are invalid.
+Given valid credentials, grants a Uffizzi user account access 
+to a private Docker Hub registry
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`DOCKERHUB_USERNAME`, `DOCKERHUB_PASSWORD`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
-    https://docs.uffizzi.com/guides/container-registry-integrations
+## OPTIONS
+
+* `-u`, `--username=<username>`:
+  Username for the service.
+* `-p`, `--password=<password>`:
+  Password for the service.
 
 ## EXAMPLES
-    The following command will prompt the user to enter Docker Hub
-    credentials, including Docker ID and password or access token:
-          
-        $ uffizzi connect docker-hub
+
+The following command will prompt the user to enter Docker Hub
+credentials, including Docker ID and password or access token:
+
+`uffizzi connect docker-hub`

data/man/uffizzi-connect-docker-registry

@@ -0,0 +1,37 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-CONNECT\-DOCKER\-REGISTRY" "" "August 2022" ""
+.SH "NAME"
+\fBuffizzi\-connect\-docker\-registry\fR \- grant a Uffizzi user account access to a Docker Container Registry\.
+.SH "SYNOPSIS"
+\fBuffizzi connect docker\-registry\fR [\-\-registry=REGISTRY] [\-\-username=USERNAME] [\-\-password=PASSWORD]
+.SH "DESCRIPTION"
+Given valid credentials, grants a Uffizzi user account access to a Docker Container Registry
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBDOCKER_REGISTRY_URL\fR, \fBDOCKER_REGISTRY_USERNAME\fR, \fBDOCKER_REGISTRY_PASSWORD\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
+For more information on connecting to external services, see:
+.br
+https://github\.com/UffizziCloud/uffizzi_cli
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
+https://docs\.uffizzi\.com/guides/container\-registry\-integrations
+.SH "OPTIONS"
+.TP
+\fB\-r\fR, \fB\-\-registry=<registry>\fR
+URL of the service\.
+.TP
+\fB\-u\fR, \fB\-\-username=<username>\fR
+Username for the service\.
+.TP
+\fB\-p\fR, \fB\-\-password=<password>\fR
+Password for the service\.
+.SH "EXAMPLES"
+The following command will prompt the user to enter Docker Container Registry credentials, including username and password:
+.P
+\fBuffizzi connect docker\-registry\fR

data/man/uffizzi-connect-docker-registry.ronn

@@ -0,0 +1,41 @@
+# uffizzi-connect-docker-registry - grant a Uffizzi user account access to a Docker Container Registry.
+
+## SYNOPSIS
+
+`uffizzi connect docker-registry` [--registry=REGISTRY] [--username=USERNAME] [--password=PASSWORD]
+
+## DESCRIPTION
+
+Given valid credentials, grants a Uffizzi user account access
+to a Docker Container Registry
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`DOCKER_REGISTRY_URL`, `DOCKER_REGISTRY_USERNAME`, `DOCKER_REGISTRY_PASSWORD`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
+
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
+
+## OPTIONS
+
+* `-r`, `--registry=<registry>`:
+  URL of the service.
+* `-u`, `--username=<username>`:
+  Username for the service.
+* `-p`, `--password=<password>`:
+  Password for the service.
+
+## EXAMPLES
+
+The following command will prompt the user to enter Docker Container Registry
+credentials, including username and password:
+
+`uffizzi connect docker-registry`

data/man/uffizzi-connect-ecr

@@ -1,35 +1,37 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-ECR" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT\-ECR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-ecr\fR \- grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect ecr
-.fi
+\fBuffizzi connect ecr\fR [\-\-registry=REGISTRY] [\-\-id=ID] [\-\-secret=SECRET]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private Amazon Elastic Container Registry
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private Amazon Elastic Container Registry
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBAWS_REGISTRY_URL\fR, \fBAWS_ACCESS_KEY_ID\fR, \fBAWS_SECRET_ACCESS_KEY\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
+.SH "OPTIONS"
+.TP
+\fB\-r\fR, \fB\-\-registry=<registry>\fR
+URL of the service\.
+.TP
+\fB\-\-id=<id>\fR
+Access key id for the service\.
+.TP
+\fB\-s\fR, \fB\-\-secret=<secret>\fR
+Secret access key for the service\.
 .SH "EXAMPLES"
-.nf
-The following command will prompt the user to enter ACR
-credentials, including registry domain, access key ID and
-secret access key:
-
-    $ uffizzi connect ecr
-.fi
-
+The following command will prompt the user to enter ACR credentials, including registry domain, access key ID and secret access key:
+.P
+\fBuffizzi connect ecr\fR

data/man/uffizzi-connect-ecr.ronn

@@ -1,28 +1,42 @@
-uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
-================================================================
+# uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
 
 ## SYNOPSIS
-    uffizzi connect ecr
+
+`uffizzi connect ecr` [--registry=REGISTRY] [--id=ID] [--secret=SECRET]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private Amazon Elastic Container Registry
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect 
-          external services.
-        - The given credentials are invalid.
+Given valid credentials, grants a Uffizzi user account access 
+to a private Amazon Elastic Container Registry
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`AWS_REGISTRY_URL`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
-    https://docs.uffizzi.com/guides/container-registry-integrations
+## OPTIONS
+
+* `-r`, `--registry=<registry>`:
+  URL of the service.
+* `--id=<id>`:
+  Access key id for the service.
+* `-s`, `--secret=<secret>`:
+  Secret access key for the service.
 
 ## EXAMPLES
-    The following command will prompt the user to enter ACR 
-    credentials, including registry domain, access key ID and 
-    secret access key:
-          
-        $ uffizzi connect ecr
+
+The following command will prompt the user to enter ACR 
+credentials, including registry domain, access key ID and 
+secret access key:
+
+`uffizzi connect ecr`

data/man/uffizzi-connect-gcr

@@ -1,40 +1,31 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-GCR" "" "May 2022" ""
+.TH "UFFIZZI\-CONNECT\-GCR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-gcr\fR \- grant a Uffizzi user account access to a private Google Container Registry (GCR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect gcr [KEY_FILE]
-.fi
+\fBuffizzi connect gcr\fR [KEY_FILE]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private Google Container Registry
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private Google Container Registry
+.P
+Credentials can be provided via a key file or environment variable:
+.br
+\fBGCLOUD_SERVICE_KEY\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
-.SH "POSITIONAL ARGUMENTS"
-.nf
+.SH "ARGUMENTS"
+.TP
 KEY_FILE
-    A Google Cloud service account key file\. The key file is a
-    JSON file that grants Uffizzi access to a private GCR\.
-.fi
+A Google Cloud service account key file\. The key file is a JSON file that grants Uffizzi access to a private GCR\.
 .SH "EXAMPLES"
-.nf
-The following command uses a Google Cloud service account key
-file called sa\-private\-key\.json to connect to a private GCR:
-
-    $ uffizzi connect gcr sa\-private\-key\.json
-.fi
-
+The following command uses a Google Cloud service account key file called sa\-private\-key\.json to connect to a private GCR:
+.P
+\fBuffizzi connect gcr sa\-private\-key\.json\fR

data/man/uffizzi-connect-gcr.ronn

@@ -1,32 +1,36 @@
-uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
-================================================================
+# uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
 
 ## SYNOPSIS
-    uffizzi connect gcr [KEY_FILE]
+
+`uffizzi connect gcr` [KEY_FILE]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access 
-    to a private Google Container Registry
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect 
-          external services.
-        - The given credentials are invalid.
+Given valid credentials, grants a Uffizzi user account access 
+to a private Google Container Registry
+
+Credentials can be provided via a key file or environment variable:  
+`GCLOUD_SERVICE_KEY`
+
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see 
-    https://docs.uffizzi.com/guides/container-registry-integrations
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
-## POSITIONAL ARGUMENTS
-    KEY_FILE
-        A Google Cloud service account key file. The key file is a 
-        JSON file that grants Uffizzi access to a private GCR.
+## ARGUMENTS
+
+* KEY_FILE:
+  A Google Cloud service account key file. The key file is a JSON file that grants Uffizzi access to a private GCR.
 
 ## EXAMPLES
-    The following command uses a Google Cloud service account key 
-    file called sa-private-key.json to connect to a private GCR:
-          
-        $ uffizzi connect gcr sa-private-key.json
+
+The following command uses a Google Cloud service account key 
+file called sa-private-key.json to connect to a private GCR:
+
+`uffizzi connect gcr sa-private-key.json`

data/man/uffizzi-connect-ghcr

@@ -1,44 +1,34 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CONNECT\-GHCR" "" "July 2022" ""
+.TH "UFFIZZI\-CONNECT\-GHCR" "" "August 2022" ""
 .SH "NAME"
 \fBuffizzi\-connect\-ghcr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 .SH "SYNOPSIS"
-.nf
-uffizzi connect ghcr [OPTION]\|\.\|\.\|\.
-.fi
+\fBuffizzi connect ghcr\fR [\-\-username=USERNAME] [\-\-token=TOKEN]
 .SH "DESCRIPTION"
-.nf
-Given valid credentials, grants a Uffizzi user account access
-to a private GitHub Container Registry\.
-
-Credentials can be provided interactively or non\-interactively
-via command options or environment variables:
-GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
-
-This command can fail for the following reasons:
-    \- The active user does not have permission to connect
-      external services\.
-    \- The given credentials are invalid\.
-
+Given valid credentials, grants a Uffizzi user account access to a private GitHub Container Registry\.
+.P
+Credentials can be provided interactively or non\-interactively via command options or environment variables:
+.br
+\fBGITHUB_USERNAME\fR, \fBGITHUB_ACCESS_TOKEN\fR
+.P
+This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
+.P
 For more information on connecting to external services, see:
+.br
 https://github\.com/UffizziCloud/uffizzi_cli
-
-For detailed instructions on configuring webhooks to send push
-notifications to Uffizzi, see
+.P
+For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
+.br
 https://docs\.uffizzi\.com/guides/container\-registry\-integrations
-.fi
 .SH "OPTIONS"
-.nf
-\-u, \-\-username        GitHub username
-\-t, \-\-token           Personal access token from GitHub
-.fi
+.TP
+\fB\-u\fR, \fB\-\-username=<username>\fR
+Username for the service\.
+.TP
+\fB\-t\fR, \fB\-\-token=<token>\fR
+Access token for the service\.
 .SH "EXAMPLES"
-.nf
-The following command will prompt the user to enter GHCR
-credentials, including GitHub account name and
-personal access token (PAT):
-
-uffizzi connect ghcr
-.fi
-
+The following command will prompt the user to enter GHCR credentials, including GitHub account name and personal access token (PAT):
+.P
+\fBuffizzi connect ghcr\fR

data/man/uffizzi-connect-ghcr.ronn

@@ -1,36 +1,40 @@
-uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
-================================================================
+# uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
 
 ## SYNOPSIS
-    uffizzi connect ghcr [OPTION]...
+
+`uffizzi connect ghcr` [--username=USERNAME] [--token=TOKEN]
 
 ## DESCRIPTION
-    Given valid credentials, grants a Uffizzi user account access
-    to a private GitHub Container Registry.
 
-    Credentials can be provided interactively or non-interactively
-    via command options or environment variables:
-    GITHUB_USERNAME, GITHUB_ACCESS_TOKEN
+Given valid credentials, grants a Uffizzi user account access
+to a private GitHub Container Registry.
+
+Credentials can be provided interactively or non-interactively
+via command options or environment variables:  
+`GITHUB_USERNAME`, `GITHUB_ACCESS_TOKEN`
 
-    This command can fail for the following reasons:
-        - The active user does not have permission to connect
-          external services.
-        - The given credentials are invalid.
+This command can fail for the following reasons:
+- The active user does not have permission to connect external services.
+- The given credentials are invalid.
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
-    For detailed instructions on configuring webhooks to send push
-    notifications to Uffizzi, see
-    https://docs.uffizzi.com/guides/container-registry-integrations
+For detailed instructions on configuring webhooks to send push
+notifications to Uffizzi, see:  
+https://docs.uffizzi.com/guides/container-registry-integrations
 
 ## OPTIONS
-    -u, --username        GitHub username
-    -t, --token           Personal access token from GitHub
+
+* `-u`, `--username=<username>`:
+  Username for the service.
+* `-t`, `--token=<token>`:
+  Access token for the service.
 
 ## EXAMPLES
-    The following command will prompt the user to enter GHCR
-    credentials, including GitHub account name and
-    personal access token (PAT):
 
-    uffizzi connect ghcr
+The following command will prompt the user to enter GHCR
+credentials, including GitHub account name and
+personal access token (PAT):
+
+`uffizzi connect ghcr`

data/man/uffizzi-connect.ronn

@@ -1,37 +1,45 @@
-uffizzi-connect - grant a Uffizzi user account access to external services
-================================================================
+# uffizzi-connect - grant a Uffizzi user account access to external services
 
 ## SYNOPSIS
-    uffizzi connect COMMAND
+
+`uffizzi connect` COMMAND [--skip-raise-existence-error] [--update-credential-if-exists]
 
 ## DESCRIPTION
-    Grants a Uffizzi user account access to external services
 
-    For more information on connecting to external services, see:
-    https://github.com/UffizziCloud/uffizzi_cli
+Grants a Uffizzi user account access to external services.
+
+For more information on connecting to external services, see:  
+https://github.com/UffizziCloud/uffizzi_cli
 
 ## COMMANDS
-    COMMAND is one of the following:
 
-    acr
-        Connect to Azure Container Registry (azurecr.io).
+COMMAND is one of the following:
+
+* `acr`:
+  Connect to Azure Container Registry (azurecr.io).
 
-    docker-hub
-        Connect to Docker Hub (hub.docker.com).
+* `docker-hub`:
+  Connect to Docker Hub (hub.docker.com).
 
-    ecr
-        Connect to Amazon Elastic Container Registry (amazonaws.com).
+* `docker-registry`:
+  Connect to any registry implementing the Docker Registry HTTP API protocol
 
-    gcr
-        Connect to Google Container Registry (gcr.io).
+* `ecr`:
+  Connect to Amazon Elastic Container Registry (amazonaws.com).
 
-    ghcr
-        Connect to GitHub Container Registry (ghcr.io).
+* `gcr`:
+  Connect to Google Container Registry (gcr.io).
+
+* `ghcr`:
+  Connect to GitHub Container Registry (ghcr.io).
 
 
 ## FLAGS
-    --skip-raise-existence-error        If credential exist, do not raise an exception, just print a message
 
-    --update-credential-if-exists       Update credential if it exists
+* `--skip-raise-existence-error`:
+  If credential exists, do not raise an exception, just print a message.
+
+* `--update-credential-if-exists`:
+  Update credential if it exists.
 
-Run 'uffizzi connect COMMAND --help' for more information on a command.
+Run `uffizzi connect COMMAND --help` for more information on a command.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.12.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -337,6 +337,7 @@ files:
 - lib/uffizzi/config_file.rb
 - lib/uffizzi/date_helper.rb
 - lib/uffizzi/error.rb
+- lib/uffizzi/helpers/connect_helper.rb
 - lib/uffizzi/helpers/project_helper.rb
 - lib/uffizzi/promt.rb
 - lib/uffizzi/response_helper.rb
@@ -355,6 +356,8 @@ files:
 - man/uffizzi-connect-acr.ronn
 - man/uffizzi-connect-docker-hub
 - man/uffizzi-connect-docker-hub.ronn
+- man/uffizzi-connect-docker-registry
+- man/uffizzi-connect-docker-registry.ronn
 - man/uffizzi-connect-ecr
 - man/uffizzi-connect-ecr.ronn
 - man/uffizzi-connect-gcr