uffizzi-cli 2.4.4 → 2.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0dca2ba03ac849c8e1ca71bac3c495b698fda210f888320b06bbac114eb2168
-  data.tar.gz: 1441cff7ebd668159423966a6b5a9604e8e377a45f8d027802c381814e297d1d
+  metadata.gz: 2f954b8f82aabbd435972f10d4070dc9463642d8d23702a80f6897e8bce74cfe
+  data.tar.gz: 53ec7b439ed075e8582ed208b5a1ab5a03cbfe4e8bc6e79b8e4abaaf76ae2ada
 SHA512:
-  metadata.gz: 310e1accb7217654da0e8d4f84364c2db240495d5c5d4df602f63a8ad87b72c798b8151817a44a95224599dfd312bd83875fd7a36e4430bb1aefdcbd5425a9f0
-  data.tar.gz: 262191965e225983bf075b45a878c49953f4f3955da4628ff64a39b5bc1641182e954a2c6d8bbc4a2808e3f4ba1382edc9b8cacfa36ac0d7de8db3bdf610c41a
+  metadata.gz: e60cab6e8a4b07c6c1871e31d15d9b27544bf800cc5c461515d69289cc579a96f3291b704a70347bb3d492bb64cb68eae761f0b31b70fc103d2eb4573441cd94
+  data.tar.gz: e9c0eb113223ff5aeda960f6f55f5e63a5057912ea663ee8cbb5b45e4ff99ff47603818d1d48c09b355bf3e43ea3780f255a370e5ef11e48683b81a075a9e1b9

data/lib/uffizzi/cli/account.rb

@@ -76,7 +76,7 @@ module Uffizzi
       account = response[:body][:account]
       account_id = account[:id]
       account_name = account[:name]
-      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(account_id, account_name))
+      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(id: account_id, name: account_name))
       Uffizzi.ui.say("The account with name '#{account_name}' was set as default.")
 
       projects = account[:projects]

data/lib/uffizzi/cli/install.rb

@@ -11,7 +11,7 @@ module Uffizzi
 
     default_task :controller
 
-    desc 'controller [HOSTNMAE]', 'Install uffizzi controller to cluster'
+    desc 'controller [HOSTNAME]', 'Install uffizzi controller to cluster'
     method_option :namespace, type: :string
     method_option :email, type: :string, required: true
     method_option :context, type: :string
@@ -20,14 +20,14 @@ module Uffizzi
     def controller(hostname)
       Uffizzi::AuthHelper.check_login
 
-      InstallService.kubectl_exists?
-      InstallService.helm_exists?
+      # InstallService.kubectl_exists?
+      # InstallService.helm_exists?
 
       if options[:context].present? && options[:context] != InstallService.kubeconfig_current_context
         InstallService.set_current_context(options[:context])
       end
 
-      ask_confirmation
+      ask_confirmation(options[:namespace])
 
       uri = parse_hostname(hostname)
       installation_options = build_installation_options(uri)
@@ -159,16 +159,8 @@ module Uffizzi
       update_controller_settings(existing_controller_setting[:id], controller_setting_params)
     end
 
-    def ask_confirmation
-      msg = "\r\n"\
-            'This command will install Uffizzi into the default namespace of'\
-            " the '#{InstallService.kubeconfig_current_context}' context."\
-            "\r\n"\
-            "To install in a different place, use options '--namespace' and/or '--context'."\
-            "\r\n\r\n"\
-            "After installation, new environments created for account '#{account_name}' will be deployed to this host cluster."\
-            "\r\n\r\n"
-
+    def ask_confirmation(namespace)
+      msg = namespace.present? ? custom_namespace_installation_message(namespace) : default_installation_message
       Uffizzi.ui.say(msg)
 
       question = 'Okay to proceed?'
@@ -263,5 +255,25 @@ module Uffizzi
     def existing_controller_setting
       @existing_controller_setting ||= fetch_controller_settings[0]
     end
+
+    def default_installation_message
+      "\r\n"\
+      "This command will install Uffizzi into the 'default' namespace of"\
+      " the '#{InstallService.kubeconfig_current_context}' context."\
+      "\r\n"\
+      "To install in a different place, use options '--namespace' and/or '--context'."\
+      "\r\n\r\n"\
+      "After installation, new environments created for account '#{account_name}' will be deployed to this host cluster."\
+      "\r\n\r\n"
+    end
+
+    def custom_namespace_installation_message(namespace)
+      "\r\n"\
+      "This command will install Uffizzi into the '#{namespace}' namespace of"\
+      " the '#{InstallService.kubeconfig_current_context}' context."\
+      "\r\n\r\n"\
+      "After installation, new environments created for account '#{account_name}' will be deployed to this host cluster."\
+      "\r\n\r\n"
+    end
   end
 end

data/lib/uffizzi/cli/login.rb

@@ -71,6 +71,7 @@ module Uffizzi
       Uffizzi.ui.say('Login successful')
 
       set_current_account_and_project
+      Uffizzi.ui.say(installation_message)
     end
 
     def open_browser(url)
@@ -88,7 +89,7 @@ module Uffizzi
 
       if ENV.fetch('CI_PIPELINE_RUN', false)
         account = response[:body][:user][:default_account]
-        return ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(account[:id]))
+        return ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(id: account[:id]))
       end
 
       set_current_account_and_project
@@ -123,7 +124,7 @@ module Uffizzi
       accounts = accounts_response[:body][:accounts]
       if accounts.length == 1
         current_account = accounts.first
-        ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(current_account[:id], current_account[:name]))
+        ConfigFile.write_option(:account, account_config(current_account))
         return current_account[:id]
       end
       question = 'Select an account:'
@@ -131,9 +132,9 @@ module Uffizzi
         { name: account[:name], value: account[:id] }
       end
       account_id = Uffizzi.prompt.select(question, choices)
-      account_name = accounts.detect { |account| account[:id] == account_id }[:name]
+      selected_account = accounts.detect { |account| account[:id] == account_id }
 
-      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(account_id, account_name))
+      ConfigFile.write_option(:account, account_config(selected_account))
 
       account_id
     end
@@ -211,5 +212,37 @@ module Uffizzi
 
       Uffizzi.ui.say("Project #{project[:name]} was successfully created")
     end
+
+    def installation_message
+      account_config = ConfigHelper.read_account_config
+      if account_config[:has_installation]
+        "\r\n\r\n"\
+        '####################################################################' \
+        "\r\n\r\n"\
+        "Your CLI is configured to use '#{account_config[:vclusters_controller_url]}'." \
+        "\r\n\r\n"\
+        'Run `uffizzi config -h` to see CLI configuration options.'\
+        "\r\n\r\n"
+      else
+        "\r\n\r\n"\
+        '####################################################################'\
+        "\r\n\r\n"\
+        'Your CLI is configured to use https://app.uffizzi.com (Uffizzi Cloud).'\
+        "\r\n\r\n"\
+        'Run `uffizzi config -h` to see CLI configuration options.'\
+        "\r\n"\
+        'Run `uffizzi install -h` to see self-hosted installation options.'\
+        "\r\n\r\n"
+      end
+    end
+
+    def account_config(account_data)
+      Uffizzi::ConfigHelper.account_config(
+        id: account_data[:id],
+        name: account_data[:name],
+        has_installation: account_data[:has_installation],
+        vclusters_controller_url: account_data[:vclusters_controller_url],
+      )
+    end
   end
 end

data/lib/uffizzi/cli/login_by_identity_token.rb

@@ -41,7 +41,7 @@ module Uffizzi
     def handle_succeed_response(response, server, oidc_token)
       ConfigFile.write_option(:server, server)
       ConfigFile.write_option(:cookie, response[:headers])
-      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(response[:body][:account_id]))
+      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(id: response[:body][:account_id]))
       ConfigFile.write_option(:project, response[:body][:project_slug])
       ConfigFile.write_option(:oidc_token, oidc_token)
 

data/lib/uffizzi/cli/project.rb

@@ -171,10 +171,11 @@ module Uffizzi
     def set_default_project(project)
       ConfigFile.write_option(:project, project[:slug])
       account = project[:account]
-      return ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(account[:id], account[:name])) if account
+      account_config = Uffizzi::ConfigHelper.account_config(id: account[:id], name: account[:name])
+      return ConfigFile.write_option(:account, account_config) if account
 
       # For core versions < core_v2.2.3
-      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(project[:account_id]))
+      ConfigFile.write_option(:account, Uffizzi::ConfigHelper.account_config(id: project[:account_id]))
     end
   end
 end

data/lib/uffizzi/cli/uninstall.rb

@@ -11,7 +11,7 @@ module Uffizzi
 
     default_task :controller
 
-    desc 'controller [HOSTNMAE]', 'Install uffizzi controller to cluster'
+    desc 'controller [HOSTNAME]', 'Install uffizzi controller to cluster'
     method_option :namespace, type: :string
     method_option :context, type: :string
     def controller

data/lib/uffizzi/helpers/config_helper.rb

@@ -17,8 +17,8 @@ module Uffizzi
         ConfigFile.option_has_value?(option) ? ConfigFile.read_option(option) : nil
       end
 
-      def account_config(id, name = nil)
-        { id: id, name: name }
+      def account_config(id:, name: nil, has_installation: false, vclusters_controller_url: nil)
+        { id: id, name: name, has_installation: has_installation, vclusters_controller_url: vclusters_controller_url }
       end
 
       def update_clusters_config_by_id(id, params)
@@ -60,6 +60,10 @@ module Uffizzi
         read_option_from_config(:dev_environment) || {}
       end
 
+      def read_account_config
+        read_option_from_config(:account)
+      end
+
       private
 
       def clusters

data/lib/uffizzi/version.rb

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

data/man/uffizzi-install.ronn

@@ -1,52 +1,55 @@
-$ uffizzi -h
-uffizzi - manage Uffizzi resources
+$ uffizzi install help
+uffizzi-install - install the uffizzi platform
 ================================================================
 
 ## SYNOPSIS
-    uffizzi GROUP | COMMAND
+    uffizzi install [HOSTNAME] --email=[EMAIL]
 
 ## DESCRIPTION
-    The uffizzi CLI manages authentication, configuration, and
-    interaction with Uffizzi APIs.
+    Install the Uffizzi platform data plane (controller and operator) on a host cluster. 
+    
+    If you want to self-host the Uffizzi platform data and control planes, you should 
+    use Uffizzi Enterprise instead. Contact sales@uffizzi.com to get started.
 
-    For more information on the uffizzi CLI, see:
-    https://docs.uffizzi.com/references/cli/
+    For more information on the Uffizzi installation process, see:
+    https://docs.uffizzi.com/install/platform
 
-## GROUP
-    GROUP is one of the following:
-     cluster
-         Manage virtual clusters
+## POSITIONAL ARGUMENTS
 
-     config
-         Configure the uffizzi CLI
+    HOSTNAME
+    The hostname where your installation will be publicly available. E.g. uffizzi.example.com
+    The output of the `install` command is an IP address or hostname where your instance 
+    of the Uffizzi controller service is available. Uffizzi expects this service to be publicly 
+    available at the specified HOSTNAME. Before you can create Uffizzi environments 
+    on your installation, be sure to configure your DNS to point HOSTNAME to the IP 
+    or hostname output by this command.
 
-     connect
-         Grant a Uffizzi user account access to external services
+    EMAIL 
+    A business email, required for letsencrypt certificate authority.
 
-     compose
-         Manage Uffizzi compose environments (previews) and view logs
+## FLAGS
 
-     dev
-         Creates a Uffizzi cluster preconfigured for development workflows
+    --email
+        A business email required for letsencrypt
 
-     install
-         Install the Uffizzi platform data plane on a host cluster.
+     --context
+        The name of the kubeconfig context to use. If no context is specified, your 
+         kubeconfig current context is used.
 
-     project
-         Manage Uffizzi project resources including compose files for
-         specifying compose environment (preview) configurations and secrets
+     --namespace
+        The namespace where Uffizzi platform will be installed. If no namespace is 
+        specified, the 'default' namespace is used.  
 
-## COMMAND
-    COMMAND is one of the following:
+    --help
+        Display this help page and exit
 
-     help
-         Show uffizzi documentation
+## EXAMPLES
 
-     login
-         Log in to a Uffizzi user account
+    To install Uffizzi using the current context at hostname 'uffizzi.example.com', run:
 
-     logout
-         Log out of a Uffizzi user account
-
-     version
-         Print version information for uffizzi CLI
+        $ uffizzi install uffizzi.example.com --email="jdoe@example.com"
+    
+    To install Uffizzi using context 'foo' and namespace 'bar', run:
+    
+        $ uffizzi install uffizzi.example.com --email="jdoe@example.com" \
+          --context='foo' --namespace='bar'

data/man/uffizzi-uninstall.ronn

@@ -0,0 +1,23 @@
+$ uffizzi uninstall help
+uffizzi-uninstall - uninstall the uffizzi platform
+================================================================
+
+## SYNOPSIS
+    uffizzi uninstall
+
+## DESCRIPTION
+    Uninstall the Uffizzi platform data plane (controller and operator) from a host cluster. 
+
+    For more information on the Uffizzi installation process, see:
+    https://docs.uffizzi.com/install/platform
+
+## FLAGS
+
+    --help
+        Display this help page and exit
+
+## EXAMPLES
+
+    To uninstall Uffizzi, run:
+
+        $ uffizzi uninstall

data/man/uffizzi.ronn

@@ -25,12 +25,19 @@ uffizzi - manage Uffizzi resources
      compose
          Manage Uffizzi compose environments (previews) and view logs
 
+     dev
+         Creates a Uffizzi cluster preconfigured for development workflows
+
+     install
+         Install the Uffizzi platform data plane on a host cluster.
+
      project
          Manage Uffizzi project resources including compose files for
          specifying compose environment (preview) configurations and secrets
 
-     dev
-         Creates a Uffizzi cluster preconfigured for development workflows
+     uninstall
+         Uninstall the Uffizzi platform data plane from a host cluster. Updates CLI 
+         to use Uffizzi Cloud as the default API.
 
 ## COMMAND
     COMMAND is one of the following:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.4.6
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-29 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -611,6 +611,7 @@ files:
 - man/uffizzi-project-set-default.ronn
 - man/uffizzi-project.html
 - man/uffizzi-project.ronn
+- man/uffizzi-uninstall.ronn
 - man/uffizzi.html
 - man/uffizzi.ronn
 homepage: https://uffizzi.com