uffizzi-cli 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd0af3bb51a08a6c011cf4271fc886586fbb262af3419aeaa02c32aa97dc29d
-  data.tar.gz: 3f588da373233552310f0490d8e0384acdd2cce6598cb3e2dc3d8435ebda2eab
+  metadata.gz: c57cec1f82e6f54de217f0d1e17b88a8ce5bb2dd58eb702df2a10930508f1203
+  data.tar.gz: b904d36aef21a479dac014429f09eebd80cb1715dfd71cf2457fea34cb5f5175
 SHA512:
-  metadata.gz: 2d821267fb032b76f69cf03a2d0e08318e46b87fc8ac2084550a293dbd18591b16c10a48abf5efd82ffff9288edfda9105e00f6db979eb06424c7f68a80c5b56
-  data.tar.gz: 3981689282eb4c43ce6bdd2281252cef925d609f879d73aeed3754cbf5b39c983d7927394ba81e1127db00ff372cbe6d8dec5ec2e092ccf28dfb9b4ec9e73bfd
+  metadata.gz: 9d5f9f27fab4efec5b44910d37e53ce60b65ba6995e89a5e65b1a7d60c0925899f7cce271c2670d728aeb66845da3c075cab9492baf1f2c45ac3d80504ae2b4f
+  data.tar.gz: c3b2a87f53468a55939cde535cf0389eaca7b2666b581312089ee0c51eed195a58366c7c763b16fad8da53ffe8ca9ba92b4cd4bfea88ccffc09397b4d6f39204

data/lib/uffizzi/cli/cluster.rb

@@ -22,7 +22,7 @@ module Uffizzi
       run('list')
     end
 
-    desc 'create [NAME]', 'Create a cluster'
+    desc 'create [CLUSTER_NAME]', 'Create a cluster'
     method_option :name, type: :string, required: false, aliases: '-n'
     method_option :kubeconfig, type: :string, required: false, aliases: '-k'
     method_option :manifest, type: :string, required: false, aliases: '-m'
@@ -34,13 +34,13 @@ module Uffizzi
       run('create', { name: name })
     end
 
-    desc 'describe [NAME]', 'Describe a cluster'
+    desc 'describe [CLUSTER_NAME]', 'Describe a cluster'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'pretty-json']
     def describe(name)
       run('describe', cluster_name: name)
     end
 
-    desc 'delete [NAME]', 'Delete a cluster'
+    desc 'delete [CLUSTER_NAME]', 'Delete a cluster'
     method_option :'delete-config', required: false, type: :boolean, default: true
     def delete(name)
       run('delete', cluster_name: name)
@@ -61,6 +61,16 @@ module Uffizzi
       run('disconnect')
     end
 
+    desc 'sleep [CLUSTER_NAME]', 'Scales a Uffizzi cluster down to zero resource utilization'
+    def sleep(name = nil)
+      run('sleep', cluster_name: name)
+    end
+
+    desc 'wake [CLUSTER_NAME]', 'Scales up a Uffizzi cluster to its original resource'
+    def wake(name = nil)
+      run('wake', cluster_name: name)
+    end
+
     private
 
     def run(command, command_args = {})
@@ -81,6 +91,10 @@ module Uffizzi
         handle_update_kubeconfig_command(project_slug, command_args)
       when 'disconnect'
         ClusterDisconnectService.handle(options)
+      when 'sleep'
+        handle_sleep_command(project_slug, command_args)
+      when 'wake'
+        handle_wake_command(project_slug, command_args)
       end
     end
 
@@ -131,7 +145,7 @@ module Uffizzi
 
       if ClusterService.failed?(cluster_data[:state])
         spinner.error
-        Uffizzi.ui.say_error_and_exit("Cluster with name: #{cluster_name} failed to be created.")
+        Uffizzi.ui.say_error_and_exit("Cluster #{cluster_name} failed to be created.")
       end
 
       spinner.success
@@ -196,7 +210,8 @@ module Uffizzi
 
     def handle_update_kubeconfig_command(project_slug, command_args)
       kubeconfig_path = options[:kubeconfig] || KubeconfigService.default_path
-      cluster_data = fetch_cluster_data(project_slug, command_args[:cluster_name])
+      cluster_name = command_args[:cluster_name]
+      cluster_data = fetch_cluster_data(project_slug, cluster_name)
 
       unless cluster_data[:kubeconfig].present?
         say_error_update_kubeconfig(cluster_data)
@@ -218,13 +233,48 @@ module Uffizzi
         new_kubeconfig
       end
 
-      update_clusters_config(cluster_data[:id], kubeconfig_path: kubeconfig_path)
+      update_clusters_config(cluster_data[:id], name: cluster_name, kubeconfig_path: kubeconfig_path)
 
       return if options[:quiet]
 
       Uffizzi.ui.say("Kubeconfig was updated by the path: #{kubeconfig_path}")
     end
 
+    def handle_sleep_command(project_slug, 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")
+    end
+
+    def handle_wake_command(project_slug, 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")
+    end
+
     def say_error_update_kubeconfig(cluster_data)
       if ClusterService.failed?(cluster_data[:state])
         Uffizzi.ui.say_error_and_exit('Kubeconfig is empty because cluster failed to be created.')
@@ -321,6 +371,7 @@ module Uffizzi
       is_update_current_context = options[:'update-current-context']
       parsed_kubeconfig = parse_kubeconfig(cluster_data[:kubeconfig])
       rendered_cluster_data = render_cluster_data(cluster_data)
+      cluster_name = cluster_data[:name]
 
       Uffizzi.ui.enable_stdout
       Uffizzi.ui.say("Cluster with name: #{rendered_cluster_data[:name]} was created.")
@@ -332,7 +383,7 @@ module Uffizzi
       Uffizzi.ui.say(rendered_cluster_data) if Uffizzi.ui.output_format
 
       save_kubeconfig(parsed_kubeconfig, kubeconfig_path)
-      update_clusters_config(cluster_data[:id], kubeconfig_path: kubeconfig_path)
+      update_clusters_config(cluster_data[:id], name: cluster_name, kubeconfig_path: kubeconfig_path)
       GithubService.write_to_github_env(rendered_cluster_data) if GithubService.github_actions_exists?
     end
 
@@ -362,6 +413,7 @@ module Uffizzi
     def update_clusters_config(id, params)
       clusters_config = Uffizzi::ConfigHelper.update_clusters_config_by_id(id, params)
       ConfigFile.write_option(:clusters, clusters_config)
+      ConfigFile.write_option(:current_cluster, ConfigHelper.cluster_config_by_id(id))
     end
 
     def render_cluster_data(cluster_data)
@@ -400,5 +452,11 @@ module Uffizzi
       previous_current_contexts = Uffizzi::ConfigHelper.set_previous_current_context_by_path(kubeconfig_path, current_context)
       ConfigFile.write_option(:previous_current_contexts, previous_current_contexts)
     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.')
+      Uffizzi.ui.say('$uffizzi cluster sleep my-cluster')
+    end
   end
 end

data/lib/uffizzi/cli/dev.rb

@@ -81,11 +81,12 @@ module Uffizzi
     def handle_succeed_cluster_creation(cluster_data)
       kubeconfig_path = options[:kubeconfig] || KubeconfigService.default_path
       parsed_kubeconfig = parse_kubeconfig(cluster_data[:kubeconfig])
+      cluster_name = cluster_data[:name]
 
-      Uffizzi.ui.say("Cluster with name: #{cluster_data[:name]} was created.")
+      Uffizzi.ui.say("Cluster with name: #{cluster_name} was created.")
 
       save_kubeconfig(parsed_kubeconfig, kubeconfig_path)
-      update_clusters_config(cluster_data[:id], kubeconfig_path: kubeconfig_path)
+      update_clusters_config(cluster_data[:id], name: cluster_name, kubeconfig_path: kubeconfig_path)
     end
 
     def save_kubeconfig(kubeconfig, kubeconfig_path)

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

@@ -262,6 +262,20 @@ module ApiClient
     build_response(response)
   end
 
+  def scale_down_cluster(server, project_slug, cluster_name)
+    uri = scale_down_cluster_uri(server, project_slug, cluster_name)
+    response = http_client.make_put_request(uri)
+
+    build_response(response)
+  end
+
+  def scale_up_cluster(server, project_slug, cluster_name)
+    uri = scale_up_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

@@ -110,6 +110,14 @@ module ApiRoutes
     "#{server}/api/cli/v1/projects/#{project_slug}/clusters/#{cluster_name}?token=#{oidc_token}"
   end
 
+  def scale_up_cluster_uri(server, project_slug, cluster_name)
+    "#{server}/api/cli/v1/projects/#{project_slug}/clusters/#{cluster_name}/scale_up"
+  end
+
+  def scale_down_cluster_uri(server, project_slug, cluster_name)
+    "#{server}/api/cli/v1/projects/#{project_slug}/clusters/#{cluster_name}/scale_down"
+  end
+
   def access_token_url(server, code)
     "#{server}/api/cli/v1/access_tokens/#{code}"
   end

data/lib/uffizzi/helpers/config_helper.rb

@@ -2,7 +2,7 @@
 
 module Uffizzi
   module ConfigHelper
-    CLUSTER_PARAMS = [:kubeconfig_path].freeze
+    CLUSTER_PARAMS = [:kubeconfig_path, :name].freeze
 
     class ConfigParamsError < StandardError
       def initialize(unavailable_params, key)

data/lib/uffizzi/services/cluster_service.rb

@@ -6,6 +6,9 @@ class ClusterService
   CLUSTER_STATE_DEPLOYING_NAMESPACE = 'deploying_namespace'
   CLUSTER_STATE_DEPLOYING = 'deploying'
   CLUSTER_STATE_DEPLOYED = 'deployed'
+  CLUSTER_STATE_SCALING_DOWN = 'scaling_down'
+  CLUSTER_STATE_SCALING_UP = 'scaling_up'
+  CLUSTER_FAILED_SCALING_UP = 'failed_scaling_up'
   CLUSTER_STATE_FAILED_DEPLOY_NAMESPACE = 'failed_deploy_namespace'
   CLUSTER_STATE_FAILED = 'failed'
   CLUSTER_NAME_MAX_LENGTH = 15
@@ -26,6 +29,18 @@ class ClusterService
       [CLUSTER_STATE_FAILED_DEPLOY_NAMESPACE, CLUSTER_STATE_FAILED].include?(cluster_state)
     end
 
+    def scaling_up?(cluster_state)
+      cluster_state === CLUSTER_STATE_SCALING_UP
+    end
+
+    def scaling_down?(cluster_state)
+      cluster_state === CLUSTER_STATE_SCALING_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)
       loop do
         params = {
@@ -43,6 +58,38 @@ class ClusterService
       end
     end
 
+    def wait_cluster_scale_up(project_slug, cluster_name)
+      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)
+
+        return cluster_data unless scaling_up?(cluster_data[:state])
+
+        sleep(5)
+      end
+    end
+
+    def wait_cluster_scale_down(project_slug, cluster_name)
+      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)
+
+        return unless scaling_down?(cluster_data[:state])
+
+        sleep(3)
+      end
+    end
+
     def generate_name
       name = Faker::Internet.domain_word[0..CLUSTER_NAME_MAX_LENGTH]
 

data/lib/uffizzi/version.rb

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

data/man/uffizzi

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI" "" "September 2023" ""
+.TH "UFFIZZI" "" "October 2023" ""
 .SH "NAME"
 \fBuffizzi\fR \- manage Uffizzi resources
 .SH "SYNOPSIS"

data/man/uffizzi-cluster-sleep.ronn

@@ -0,0 +1,30 @@
+$ uffizzi cluster sleep -h
+uffizzi-cluster-sleep - put a cluster to sleep (non-destructive)
+================================================================
+
+## SYNOPSIS
+    uffizzi cluster sleep [CLUSTER_NAME]
+
+## DESCRIPTION
+    Scales a Uffizzi cluster down to zero resource utilization 
+    while keeping the namespace and any stateful resources,
+    like persistent volume claims. If no CLUSTER_NAME is 
+    specified, the kubeconfig current context is used.
+
+    For more information on Uffizzi clusters, see:
+    https://docs.uffizzi.com/references/cli/
+
+## OPTIONS
+    CLUSTER_NAME
+    The name of the target Uffizzi cluster
+
+## EXAMPLES
+    To put the Uffizzi cluster in the current context to 
+    sleep, run:
+
+        $ uffizzi cluster sleep
+
+    To put a Uffizzi cluster outside the current context to 
+    sleep, run:
+
+        $ uffizzi cluster sleep my-cluster

data/man/uffizzi-cluster-wake.ronn

@@ -0,0 +1,28 @@
+$ uffizzi cluster wake -h
+uffizzi-cluster-wake - wake a cluster that is sleeping
+================================================================
+
+## SYNOPSIS
+    uffizzi cluster wake [CLUSTER_NAME]
+
+## DESCRIPTION
+    Scales up a Uffizzi cluster to its original resource 
+    utilization from zero (see 'uffizzi cluster sleep -h'). 
+    If no CLUSTER_NAME is specified, the kubeconfig current 
+    context is used.
+
+    For more information on Uffizzi clusters, see:
+    https://docs.uffizzi.com/references/cli/
+
+## OPTIONS
+    CLUSTER_NAME
+    The name of the target Uffizzi cluster
+
+## EXAMPLES
+    To wake the Uffizzi cluster in the current context, run:
+
+        $ uffizzi cluster wake
+
+    To wake a Uffizzi cluster outside the current context, run:
+
+        $ uffizzi cluster wake my-cluster

data/man/uffizzi-cluster.ronn

@@ -25,6 +25,12 @@ uffizzi-cluster - manage clusters
      list
         List all clusters
 
+     sleep
+        Put a cluster to sleep (non-destructive)
+
+     wake
+        Wake a cluster that is sleeping
+
      update-kubeconfig
         Update kubeconfig file
 

data/man/uffizzi-dev

@@ -0,0 +1,51 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-DEV" "" "October 2023" ""
+.SH "NAME"
+\fBuffizzi\-dev\fR \- manage dev environments
+.SH "SYNOPSIS"
+.nf
+uffizzi dev COMMAND
+.fi
+.SH "DESCRIPTION"
+.nf
+Manage Uffizzi development environments\.
+
+Use these commands for building, pushing, and deploying your
+project changes to a remote development cluster\. Cloud\-based
+dev environments offer many benefits compared to traditional
+local development, including:
+  \- More similar to production deployments
+  \- Access to more memory and CPU for resource\-intensive
+    apps
+  \- Scalability and flexibility for microservices apps
+  \- Faster build times
+  \- Avoid accumulation of build artifacts on local machine
+  \- App components available at public URLs or IP addresses
+  \- TLS certificates for HTTPS
+  \- Better team collaboration via shareable links
+
+For more information on Uffizzi clusters, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "COMMANDS"
+.nf
+COMMAND is one of the following:
+
+ start
+    Start a dev environment
+
+ stop
+    Stop a dev environment
+
+ describe
+    Display details of a dev environment
+
+ ingress
+    Display ingress hosts
+.fi
+.SH "HELP"
+.nf
+Run \'uffizzi dev COMMAND \-\-help\' for more information on a command\.
+.fi
+

data/man/uffizzi-dev.ronn

@@ -0,0 +1,43 @@
+uffizzi-dev - manage dev environments
+================================================================
+
+## SYNOPSIS
+    uffizzi dev COMMAND
+
+## DESCRIPTION
+    Manage Uffizzi development environments.
+
+    Use these commands for building, pushing, and deploying your
+    project changes to a remote development cluster. Cloud-based
+    dev environments offer many benefits compared to traditional
+    local development, including:
+      - More similar to production deployments
+      - Access to more memory and CPU for resource-intensive
+        apps
+      - Scalability and flexibility for microservices apps
+      - Faster build times
+      - Avoid accumulation of build artifacts on local machine
+      - App components available at public URLs or IP addresses
+      - TLS certificates for HTTPS
+      - Better team collaboration via shareable links
+
+    For more information on Uffizzi clusters, see:
+    https://docs.uffizzi.com/references/cli/
+
+## COMMANDS
+    COMMAND is one of the following:
+
+     start
+        Start a dev environment
+
+     stop
+        Stop a dev environment
+
+     describe
+        Display details of a dev environment
+
+     ingress
+        Display ingress hosts
+
+## HELP
+    Run 'uffizzi dev 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: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -480,8 +480,10 @@ files:
 - man/uffizzi-cluster-disconnect.ronn
 - man/uffizzi-cluster-list
 - man/uffizzi-cluster-list.ronn
+- man/uffizzi-cluster-sleep.ronn
 - man/uffizzi-cluster-update-kubeconfig
 - man/uffizzi-cluster-update-kubeconfig.ronn
+- man/uffizzi-cluster-wake.ronn
 - man/uffizzi-cluster.ronn
 - man/uffizzi-compose
 - man/uffizzi-compose-create
@@ -519,10 +521,12 @@ files:
 - man/uffizzi-connect-ghcr
 - man/uffizzi-connect-ghcr.ronn
 - man/uffizzi-connect.ronn
+- man/uffizzi-dev
 - man/uffizzi-dev-start
 - man/uffizzi-dev-start.ronn
 - man/uffizzi-dev-stop
 - man/uffizzi-dev-stop.ronn
+- man/uffizzi-dev.ronn
 - man/uffizzi-disconnect
 - man/uffizzi-disconnect.ronn
 - man/uffizzi-login