uffizzi-cli 2.3.4 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9881a62c56ed3ef3171721ef7e6f6374482f4068f268aa1f5a0b5864b6c8cec6
-  data.tar.gz: cc60bbc447f3f30759a74fa7fa916aab28134b9e05d97ecd1f0a69c8ba042cae
+  metadata.gz: 1267ece15e161c558b60dd16dc1d6562417f1555eefb3fcf2f65cb2f32223295
+  data.tar.gz: 4d5a80140a3436822c56a5cb1f3930ccb18082d93359c5cda3cf2343348cc282
 SHA512:
-  metadata.gz: 03c1494d690dd6bf8ef266cb815d08260bb0c609a22215f9e3ba8e9618a9598345c7161b6bdee18bafb5a45927f17c821239b069c50781a52420ab1746564a21
-  data.tar.gz: 847557bd05438144d2d964308a15dbc270105eb97c19c1971402e7b83c1ac82b90e611609ae0777ebd20f7e778e57ba0b4c1189db5c64c5a9fb58eefc3d6064e
+  metadata.gz: f2092483072296f1fd039d8acf049b53f4ef2b799c09063eb7ce0251f747837865c09f5d222f5e011c65826991fc4eb35cc7cd85d08dfaa8b3418c7270a6bb06
+  data.tar.gz: 20a062cf54e7f5b9a04d618e0066cacbf837254bb5f5c6abc7e26a0ed959a814012cceb8af3bfbefb675ad2d431fee6fa0c250229e57a4480a838929b9ff2fa1

data/lib/uffizzi/cli/cluster.rb

@@ -96,9 +96,9 @@ module Uffizzi
       when 'disconnect'
         ClusterDisconnectService.handle(options)
       when 'sleep'
-        handle_sleep_command(project_slug, command_args)
+        handle_sleep_command(command_args)
       when 'wake'
-        handle_wake_command(project_slug, command_args)
+        handle_wake_command(command_args)
       end
     end
 
@@ -141,7 +141,7 @@ module Uffizzi
 
       spinner = TTY::Spinner.new("[:spinner] Creating cluster #{cluster_name}...", format: :dots)
       spinner.auto_spin
-      cluster_data = ClusterService.wait_cluster_deploy(project_slug, cluster_name, oidc_token)
+      cluster_data = ClusterService.wait_cluster_deploy(cluster_name, cluster_api_connection_params)
 
       if ClusterService.failed?(cluster_data[:state])
         spinner.error
@@ -220,41 +220,27 @@ module Uffizzi
       return if options[:quiet]
 
       Uffizzi.ui.say("Kubeconfig was updated by the path: #{kubeconfig_path}")
+
+      synced_cluster_data = ClusterService.sync_cluster_data(command_args[:cluster_name], server: server, project_slug: project_slug)
+      cluster_state = synced_cluster_data[:state]
+      return if ClusterService.deployed?(cluster_state)
+
+      Uffizzi.ui.say(ClusterService.cluster_status_text_map[cluster_state])
+      handle_scale_up_cluster(cluster_name, cluster_api_connection_params) if ClusterService.scaled_down?(cluster_state)
     end
 
-    def handle_sleep_command(project_slug, command_args)
+    def handle_sleep_command(command_args)
       cluster_name = command_args[:cluster_name] || ConfigFile.read_option(:current_cluster)&.fetch(:name)
       return handle_missing_cluster_name_error if cluster_name.nil?
 
-      response = scale_down_cluster(ConfigFile.read_option(:server), project_slug, cluster_name)
-      return ResponseHelper.handle_failed_response(response) unless ResponseHelper.ok?(response)
-
-      spinner = TTY::Spinner.new("[:spinner] Scaling down cluster #{cluster_name}...", format: :dots)
-      spinner.auto_spin
-      ClusterService.wait_cluster_scale_down(project_slug, cluster_name)
-
-      spinner.success
-      Uffizzi.ui.say("Cluster #{cluster_name} was successfully scaled down")
+      handle_scale_down_cluster(cluster_name, cluster_api_connection_params)
     end
 
-    def handle_wake_command(project_slug, command_args)
+    def handle_wake_command(command_args)
       cluster_name = command_args[:cluster_name] || ConfigFile.read_option(:current_cluster)&.fetch(:name)
       return handle_missing_cluster_name_error if cluster_name.nil?
 
-      response = scale_up_cluster(ConfigFile.read_option(:server), project_slug, cluster_name)
-      return ResponseHelper.handle_failed_response(response) unless ResponseHelper.ok?(response)
-
-      spinner = TTY::Spinner.new("[:spinner] Waking up cluster #{cluster_name}...", format: :dots)
-      spinner.auto_spin
-      cluster_data = ClusterService.wait_cluster_scale_up(project_slug, cluster_name)
-
-      if ClusterService.failed_scaling_up?(cluster_data[:state])
-        spinner.error
-        Uffizzi.ui.say_error_and_exit("Failed to wake up cluster #{cluster_name}.")
-      end
-
-      spinner.success
-      Uffizzi.ui.say("Cluster #{cluster_name} was successfully scaled up")
+      handle_scale_up_cluster(cluster_name, cluster_api_connection_params)
     end
 
     def say_error_update_kubeconfig(cluster_data)
@@ -355,6 +341,35 @@ module Uffizzi
       Psych.safe_load(Base64.decode64(kubeconfig))
     end
 
+    def handle_scale_up_cluster(cluster_name, cluster_api_connection_params)
+      response = scale_up_cluster(cluster_api_connection_params[:server], project_slug, cluster_name)
+      return ResponseHelper.handle_failed_response(response) unless ResponseHelper.ok?(response)
+
+      spinner = TTY::Spinner.new("[:spinner] Waking up cluster #{cluster_name}...", format: :dots)
+      spinner.auto_spin
+      cluster_data = ClusterService.wait_cluster_scale_up(cluster_name, cluster_api_connection_params)
+
+      if ClusterService.failed_scaling_up?(cluster_data[:state])
+        spinner.error
+        Uffizzi.ui.say_error_and_exit("Failed to scale up cluster #{cluster_name}.")
+      end
+
+      spinner.success
+      Uffizzi.ui.say("Cluster #{cluster_name} was successfully scaled up")
+    end
+
+    def handle_scale_down_cluster(cluster_name, cluster_api_connection_params)
+      response = scale_down_cluster(cluster_api_connection_params[:server], project_slug, cluster_name)
+      return ResponseHelper.handle_failed_response(response) unless ResponseHelper.ok?(response)
+
+      spinner = TTY::Spinner.new("[:spinner] Scaling down cluster #{cluster_name}...", format: :dots)
+      spinner.auto_spin
+      ClusterService.wait_cluster_scale_down(cluster_name, cluster_api_connection_params)
+
+      spinner.success
+      Uffizzi.ui.say("Cluster #{cluster_name} was successfully scaled down")
+    end
+
     def handle_missing_cluster_name_error
       Uffizzi.ui.say("No kubeconfig found at #{KubeconfigService.default_path}")
       Uffizzi.ui.say('Please update the current context or provide a cluster name.')

data/lib/uffizzi/cli/dev.rb

@@ -116,7 +116,7 @@ module Uffizzi
 
     def wait_cluster_creation(cluster_name)
       Uffizzi.ui.say('Checking the cluster status...')
-      cluster_data = ClusterService.wait_cluster_deploy(project_slug, cluster_name, oidc_token)
+      cluster_data = ClusterService.wait_cluster_deploy(cluster_name, cluster_api_connection_params)
 
       if ClusterService.failed?(cluster_data[:state])
         Uffizzi.ui.say_error_and_exit("Cluster with name: #{cluster_name} failed to be created.")

data/lib/uffizzi/cli/status.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'uffizzi'
+require 'uffizzi/config_file'
+
+module Uffizzi
+  class Cli::Status < Thor
+    include ApiClient
+
+    default_task :describe
+
+    desc 'describe', 'Show account status'
+    def describe
+      Uffizzi::AuthHelper.check_login
+
+      account_name = ConfigFile.read_option(:account)[:name]
+      response = fetch_account(ConfigFile.read_option(:server), account_name)
+
+      if ResponseHelper.ok?(response)
+        handle_describe_success_response(response)
+      elsif ResponseHelper.not_found?(response)
+        Uffizzi.ui.say("Account with name #{account_name} does not exist")
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    private
+
+    def handle_describe_success_response(response)
+      account = response[:body][:account]
+      account_rendered_params = {
+        account: account[:name],
+        plan: "Uffizzi #{account[:product_name]}",
+        api: account[:api_url],
+        controller: account[:vclusters_controller_url],
+      }
+
+      Uffizzi.ui.output_format = Uffizzi::UI::Shell::PRETTY_LIST
+      Uffizzi.ui.say(account_rendered_params)
+    end
+  end
+end

data/lib/uffizzi/cli.rb

@@ -83,6 +83,10 @@ module Uffizzi
     require_relative 'cli/uninstall'
     subcommand 'uninstall', Cli::Uninstall
 
+    desc 'status', 'status'
+    require_relative 'cli/status'
+    subcommand 'status', Cli::Status
+
     map preview: :compose
 
     class << self

data/lib/uffizzi/clients/api/api_client.rb

@@ -276,6 +276,13 @@ module ApiClient
     build_response(response)
   end
 
+  def sync_cluster(server, project_slug, cluster_name)
+    uri = sync_cluster_uri(server, project_slug, cluster_name)
+    response = http_client.make_put_request(uri)
+
+    build_response(response)
+  end
+
   def create_access_token(server, session_id)
     uri = access_tokens_url(server)
 

data/lib/uffizzi/clients/api/api_routes.rb

@@ -124,6 +124,10 @@ module ApiRoutes
     "#{server}/api/cli/v1/projects/#{project_slug}/clusters/#{cluster_name}/scale_down"
   end
 
+  def sync_cluster_uri(server, project_slug, cluster_name)
+    "#{server}/api/cli/v1/projects/#{project_slug}/clusters/#{cluster_name}/sync"
+  end
+
   def access_token_url(server, code)
     "#{server}/api/cli/v1/access_tokens/#{code}"
   end

data/lib/uffizzi/services/cluster_service.rb

@@ -8,6 +8,7 @@ class ClusterService
   CLUSTER_STATE_DEPLOYING = 'deploying'
   CLUSTER_STATE_DEPLOYED = 'deployed'
   CLUSTER_STATE_SCALING_DOWN = 'scaling_down'
+  CLUSTER_STATE_SCALED_DOWN = 'scaled_down'
   CLUSTER_STATE_SCALING_UP = 'scaling_up'
   CLUSTER_FAILED_SCALING_UP = 'failed_scaling_up'
   CLUSTER_STATE_FAILED_DEPLOY_NAMESPACE = 'failed_deploy_namespace'
@@ -38,53 +39,35 @@ class ClusterService
       cluster_state === CLUSTER_STATE_SCALING_DOWN
     end
 
+    def scaled_down?(cluster_state)
+      cluster_state === CLUSTER_STATE_SCALED_DOWN
+    end
+
     def failed_scaling_up?(cluster_state)
       cluster_state === CLUSTER_FAILED_SCALING_UP
     end
 
-    def wait_cluster_deploy(project_slug, cluster_name, oidc_token)
+    def wait_cluster_deploy(cluster_name, cluster_api_connection_params)
       loop do
-        params = {
-          cluster_name: cluster_name,
-          oidc_token: oidc_token,
-        }
-        response = get_cluster(Uffizzi::ConfigFile.read_option(:server), project_slug, params)
-        return Uffizzi::ResponseHelper.handle_failed_response(response) unless Uffizzi::ResponseHelper.ok?(response)
-
-        cluster_data = response.dig(:body, :cluster)
-
+        cluster_data = fetch_cluster_data(cluster_name, **cluster_api_connection_params)
         return cluster_data unless deploying?(cluster_data[:state])
 
         sleep(5)
       end
     end
 
-    def wait_cluster_scale_up(project_slug, cluster_name)
+    def wait_cluster_scale_up(cluster_name, cluster_api_connection_params)
       loop do
-        params = {
-          cluster_name: cluster_name,
-        }
-        response = get_cluster(Uffizzi::ConfigFile.read_option(:server), project_slug, params)
-        return Uffizzi::ResponseHelper.handle_failed_response(response) unless Uffizzi::ResponseHelper.ok?(response)
-
-        cluster_data = response.dig(:body, :cluster)
-
+        cluster_data = fetch_cluster_data(cluster_name, **cluster_api_connection_params)
         return cluster_data unless scaling_up?(cluster_data[:state])
 
         sleep(5)
       end
     end
 
-    def wait_cluster_scale_down(project_slug, cluster_name)
+    def wait_cluster_scale_down(cluster_name, cluster_api_connection_params)
       loop do
-        params = {
-          cluster_name: cluster_name,
-        }
-        response = get_cluster(Uffizzi::ConfigFile.read_option(:server), project_slug, params)
-        return Uffizzi::ResponseHelper.handle_failed_response(response) unless Uffizzi::ResponseHelper.ok?(response)
-
-        cluster_data = response.dig(:body, :cluster)
-
+        cluster_data = fetch_cluster_data(cluster_name, **cluster_api_connection_params)
         return unless scaling_down?(cluster_data[:state])
 
         sleep(3)
@@ -120,6 +103,16 @@ class ClusterService
       end
     end
 
+    def sync_cluster_data(cluster_name, server:, project_slug:)
+      response = sync_cluster(server, project_slug, cluster_name)
+
+      if Uffizzi::ResponseHelper.ok?(response)
+        response.dig(:body, :cluster)
+      else
+        Uffizzi::ResponseHelper.handle_failed_response(response)
+      end
+    end
+
     def build_render_data(cluster_data)
       {
         name: cluster_data[:name],
@@ -128,5 +121,16 @@ class ClusterService
         host: cluster_data[:host],
       }
     end
+
+    def cluster_status_text_map
+      {
+        CLUSTER_STATE_SCALING_UP => 'The cluster is scaling up',
+        CLUSTER_STATE_SCALED_DOWN => 'The cluster is scaled down',
+        CLUSTER_STATE_SCALING_DOWN => 'The cluster is scaling down',
+        CLUSTER_FAILED_SCALING_UP => 'The cluster failed scaling up',
+        CLUSTER_STATE_FAILED_DEPLOY_NAMESPACE => 'The cluster failed',
+        CLUSTER_STATE_FAILED => 'The cluster failed',
+      }
+    end
   end
 end

data/lib/uffizzi/version.rb

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

data/man/uffizzi-cluster-update-kubeconfig.ronn

@@ -1,3 +1,4 @@
+$ uffizzi cluster update-kubeconfig -h
 uffizzi-cluster-update-kubeconfig - update a kubeconfig
 ================================================================
 
@@ -5,7 +6,8 @@ uffizzi-cluster-update-kubeconfig - update a kubeconfig
     uffizzi cluster update-kubeconfig [CLUSTER_NAME]
 
 ## DESCRIPTION
-    Update your kubeconfig file.
+    Update your kubeconfig file such that you can use kubectl to connect 
+    to a Uffizzi cluster.
 
     This command can fail for the following reasons:
         - Your kubeconfig file out of specification
@@ -13,6 +15,11 @@ uffizzi-cluster-update-kubeconfig - update a kubeconfig
     For more information on Uffizzi clusters, see:
     https://docs.uffizzi.com/references/cli/
 
+## POSITIONAL ARGUMENTS
+    CLUSTER_NAME
+        The name of the cluster for which to create a kubeconfig entry. 
+        This cluster must exist in your account.
+
 ## FLAGS
     --kubeconfig="/path/to/your/kubeconfig"
         Path to kubeconfig file you want to update
@@ -24,6 +31,6 @@ uffizzi-cluster-update-kubeconfig - update a kubeconfig
         Quiet mode
 
 ## EXAMPLES
-    To update kubeconfig file, run:
+    To update kubeconfig file for cluster 'my-cluster', run:
 
-        $ uffizzi cluster update-kubeconfig --kubeconfig="/file/path/to/kubeconfig"
+        $ uffizzi cluster update-kubeconfig my-cluster --kubeconfig="/file/path/to/kubeconfig"

data/man/uffizzi-install.ronn

@@ -1,50 +1,52 @@
-$ uffizzi install help
-uffizzi-install - install the uffizzi platform
+$ uffizzi -h
+uffizzi - manage Uffizzi resources
 ================================================================
 
 ## SYNOPSIS
-    uffizzi install [HOSTNAME]
+    uffizzi GROUP | COMMAND
 
 ## DESCRIPTION
-    Install the Uffizzi platform on a host cluster. By default, this command uses your
-    kubeconfig current context as the host.
+    The uffizzi CLI manages authentication, configuration, and
+    interaction with Uffizzi APIs.
 
-    The output of this 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.
+    For more information on the uffizzi CLI, see:
+    https://docs.uffizzi.com/references/cli/
 
-    If you're looking for an air-gapped or local installation of Uffizzi, please contact
-    sales@uffizzi.com or try the open-source version (docs.uffizzi.com/open-source).
+## GROUP
+    GROUP is one of the following:
+     cluster
+         Manage virtual clusters
 
-    EMAIL is a business email, required for letsencrypt cert authority.
+     config
+         Configure the uffizzi CLI
 
-    For more information on the Uffizzi installation process, see:
-    https://docs.uffizzi.com/cli/commands/install
+     connect
+         Grant a Uffizzi user account access to external services
 
-## FLAGS
+     compose
+         Manage Uffizzi compose environments (previews) and view logs
 
-    --email
-        A business email required for letsencrypt
+     dev
+         Creates a Uffizzi cluster preconfigured for development workflows
 
-     --context
-        The name of the kubeconfig context to use
+     install
+         Install the Uffizzi platform data plane on a host cluster.
 
-     --namespace
-        The namespace where Uffizzi platform will be installed
+     project
+         Manage Uffizzi project resources including compose files for
+         specifying compose environment (preview) configurations and secrets
 
-    --help
-        Display this help page and exit
+## COMMAND
+    COMMAND is one of the following:
 
-## EXAMPLES
+     help
+         Show uffizzi documentation
 
-    To install Uffizzi using the current context at hostname
-    'uffizzi.example.com', run:
+     login
+         Log in to a Uffizzi user account
 
-        $ uffizzi install uffizzi.example.com --email="jdoe@example.com"
+     logout
+         Log out of a Uffizzi user account
 
-    To install Uffizzi using context 'foo' and namespace 'bar', run:
-
-        $ uffizzi install uffizzi.example.com --email="jdoe@example.com" \
-          --context='foo' --namespace='bar'
+     version
+         Print version information for uffizzi CLI

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.4.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -435,6 +435,7 @@ files:
 - lib/uffizzi/cli/project.rb
 - lib/uffizzi/cli/project/compose.rb
 - lib/uffizzi/cli/project/secret.rb
+- lib/uffizzi/cli/status.rb
 - lib/uffizzi/cli/uninstall.rb
 - lib/uffizzi/clients/api/api_client.rb
 - lib/uffizzi/clients/api/api_routes.rb