uffizzi-cli 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fc9021c07ec1fbbbd32baab4e37dcdf3eb9b7368843701e9c0a086da8eefefe
-  data.tar.gz: ccf95b0bd9ae6fffa906a15012825a9c9d4b209263e0735ce200d5ba5ca953b8
+  metadata.gz: 53375ab753d707ea69a899c201838dcc0874a185185532b64f3a3cb8b07720fa
+  data.tar.gz: 177486674f4ba6f11935536cd538ddc6e587ba5a330b738196f082b8fff96c3a
 SHA512:
-  metadata.gz: aeb135bb03097b24c39b408e10bc31fa995d3cd4da3284eacc07be126b04a5aaf18a02e5cf432e5e9f46a24bb842c79209d3100ec8d0b94efde7f8c9a5b43ae4
-  data.tar.gz: 29d2160ec30fd61f9f5bf96ef24dea226b6388e9ab1bcf47b3c6a66a2b518df17bc9013d5d036dc5f3c6b517e30f2de0015a46d2ce933f8332113943e84a9b54
+  metadata.gz: 7278e21c0ce0a61da3403a874d7ce1e1d9771fd9f45867e4fdf126840fb4ddbc0e86c037be58a3bd9d0311631a819081361c4626c78cf11fdab3e6c89380fee6
+  data.tar.gz: 3d09264798892e9c97074d073940922bb2e7703941496bc5a77c6ba555ba6de3e275c3151b7dbd480d9e7b6be6f350ea1e939898c33b2bcfc8e64b8f562d6193

data/lib/uffizzi/cli/cluster.rb

@@ -11,8 +11,6 @@ require 'uffizzi/services/cluster_service'
 require 'uffizzi/services/kubeconfig_service'
 require 'uffizzi/services/cluster/disconnect_service'
 
-MANUAL = 'manual'
-
 module Uffizzi
   class Cli::Cluster < Thor
     class Error < StandardError; end
@@ -115,7 +113,7 @@ module Uffizzi
       end
 
       cluster_name = command_args[:name] || options[:name] || ClusterService.generate_name
-      creation_source = options[:"creation-source"] || MANUAL
+      creation_source = options[:"creation-source"] || ClusterService::MANUAL_CREATION_SOURCE
 
       unless ClusterService.valid_name?(cluster_name)
         Uffizzi.ui.say_error_and_exit("Cluster name: #{cluster_name} is not valid.")

data/lib/uffizzi/cli/dev.rb

@@ -2,6 +2,7 @@
 
 require 'uffizzi/services/command_service'
 require 'uffizzi/services/cluster_service'
+require 'uffizzi/services/dev_service'
 require 'uffizzi/services/kubeconfig_service'
 
 module Uffizzi
@@ -9,12 +10,22 @@ module Uffizzi
     include ApiClient
 
     desc 'start [CONFIG]', 'Start dev environment'
+    method_option :quiet, type: :boolean, aliases: :q
+    method_option :'default-repo', type: :string
+    method_option :kubeconfig, type: :string
     def start(config_path = 'skaffold.yaml')
-      check_skaffold_existence
+      DevService.check_skaffold_existence
+      DevService.check_running_daemon if options[:quiet]
+      DevService.check_skaffold_config_existence(config_path)
       check_login
       cluster_id, cluster_name = start_create_cluster
       kubeconfig = wait_cluster_creation(cluster_name)
-      launch_scaffold(config_path)
+
+      if options[:quiet]
+        launch_demonise_skaffold(config_path)
+      else
+        DevService.start_basic_skaffold(config_path, options)
+      end
     ensure
       if defined?(cluster_name).present? && defined?(cluster_id).present?
         kubeconfig = defined?(kubeconfig).present? ? kubeconfig : nil
@@ -22,6 +33,20 @@ module Uffizzi
       end
     end
 
+    desc 'stop', 'Stop dev environment'
+    def stop
+      return Uffizzi.ui.say('Uffizzi dev is not running') unless File.exist?(DevService.pid_path)
+
+      pid = File.read(DevService.pid_path).to_i
+      File.delete(DevService.pid_path)
+
+      Uffizzi.process.kill('QUIT', pid)
+      Uffizzi.ui.say('Uffizzi dev was stopped')
+    rescue Errno::ESRCH
+      Uffizzi.ui.say('Uffizzi dev is not running')
+      File.delete(DevService.pid_path)
+    end
+
     private
 
     def check_login
@@ -31,7 +56,7 @@ module Uffizzi
 
     def start_create_cluster
       cluster_name = ClusterService.generate_name
-      creation_source = MANUAL
+      creation_source = ClusterService::MANUAL_CREATION_SOURCE
       params = cluster_creation_params(cluster_name, creation_source)
       Uffizzi.ui.say('Start creating a cluster')
       response = create_cluster(ConfigFile.read_option(:server), project_slug, params)
@@ -56,7 +81,7 @@ module Uffizzi
     end
 
     def handle_succeed_cluster_creation(cluster_data)
-      kubeconfig_path = KubeconfigService.default_path
+      kubeconfig_path = options[:kubeconfig] || KubeconfigService.default_path
       parsed_kubeconfig = parse_kubeconfig(cluster_data[:kubeconfig])
 
       Uffizzi.ui.say("Cluster with name: #{cluster_data[:name]} was created.")
@@ -99,6 +124,8 @@ module Uffizzi
     end
 
     def handle_delete_cluster(cluster_id, cluster_name, kubeconfig)
+      return if cluster_id.nil? || cluster_name.nil?
+
       exclude_kubeconfig(cluster_id, kubeconfig) if kubeconfig.present?
 
       params = {
@@ -149,25 +176,19 @@ module Uffizzi
       Psych.safe_load(Base64.decode64(kubeconfig))
     end
 
-    def launch_scaffold(config_path)
-      Uffizzi.ui.say('Start skaffold')
-      cmd = "skaffold dev --filename='#{config_path}'"
+    def launch_demonise_skaffold(config_path)
+      Uffizzi.process.daemon(true)
 
-      Uffizzi.ui.popen2e(cmd) do |_stdin, stdout_and_stderr, wait_thr|
-        stdout_and_stderr.each { |l| puts l }
-        wait_thr.value
+      at_exit do
+        File.delete(DevService.pid_path) if File.exist?(DevService.pid_path)
       end
-    end
-
-    def check_skaffold_existence
-      cmd = 'skaffold version'
-      stdout_str, stderr_str = Uffizzi.ui.capture3(cmd)
-
-      return if stdout_str.present? && stderr_str.blank?
 
-      Uffizzi.ui.say_error_and_exit(stderr_str)
+      File.delete(DevService.logs_path) if File.exist?(DevService.logs_path)
+      File.write(DevService.pid_path, Uffizzi.process.pid)
+      DevService.start_check_pid_file_existence
+      DevService.start_demonised_skaffold(config_path, options)
     rescue StandardError => e
-      Uffizzi.ui.say_error_and_exit(e.message)
+      File.open(DevService.logs_path, 'a') { |f| f.puts(e.message) }
     end
 
     def project_slug

data/lib/uffizzi/config_file.rb

@@ -5,6 +5,7 @@ require 'uffizzi/helpers/file_helper'
 
 module Uffizzi
   class ConfigFile
+    CONFIG_DIR = "#{Dir.home}/.config/uffizzi"
     CONFIG_PATH = "#{Dir.home}/.config/uffizzi/config_default.json"
 
     class << self

data/lib/uffizzi/services/cluster_service.rb

@@ -9,6 +9,7 @@ class ClusterService
   CLUSTER_STATE_FAILED_DEPLOY_NAMESPACE = 'failed_deploy_namespace'
   CLUSTER_STATE_FAILED = 'failed'
   CLUSTER_NAME_MAX_LENGTH = 15
+  MANUAL_CREATION_SOURCE = 'manual'
 
   class << self
     include ApiClient

data/lib/uffizzi/services/dev_service.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'uffizzi/clients/api/api_client'
+
+class DevService
+  class << self
+    include ApiClient
+
+    DEFAULT_REGISTRY_REPO = 'registry.uffizzi.com'
+
+    def check_running_daemon
+      return unless File.exist?(pid_path)
+
+      pid = File.read(pid_path)
+      File.delete(pid_path) if pid.blank?
+      Uffizzi.process.kill(0, pid.to_i)
+
+      Uffizzi.ui.say_error_and_exit("You have already started uffizzi dev as daemon. To stop the process do 'uffizzi dev stop'")
+    rescue Errno::ESRCH
+      File.delete(pid_path)
+    end
+
+    def start_check_pid_file_existence
+      Thread.new do
+        loop do
+          Uffizzi.process.kill('QUIT', Uffizzi.process.pid) unless File.exist?(pid_path)
+          sleep(1)
+        end
+      end
+    end
+
+    def start_basic_skaffold(config_path, options)
+      Uffizzi.ui.say('Start skaffold')
+      cmd = build_skaffold_dev_command(config_path, options)
+
+      Uffizzi.ui.popen2e(cmd) do |_stdin, stdout_and_stderr, wait_thr|
+        stdout_and_stderr.each { |l| Uffizzi.ui.say(l) }
+        wait_thr.value
+      end
+    end
+
+    def start_demonised_skaffold(config_path, options)
+      File.write(logs_path, "Start skaffold\n")
+      cmd = build_skaffold_dev_command(config_path, options)
+
+      Uffizzi.ui.popen2e(cmd) do |_stdin, stdout_and_stderr, wait_thr|
+        File.open(logs_path, 'a') do |f|
+          stdout_and_stderr.each do |line|
+            f.puts(line)
+            f.flush
+          end
+        end
+
+        wait_thr.value
+      end
+    end
+
+    def check_skaffold_existence
+      cmd = 'skaffold version'
+      stdout_str, stderr_str = Uffizzi.ui.capture3(cmd)
+
+      return if stdout_str.present? && stderr_str.blank?
+
+      Uffizzi.ui.say_error_and_exit(stderr_str)
+    rescue StandardError => e
+      Uffizzi.ui.say_error_and_exit(e.message)
+    end
+
+    def check_skaffold_config_existence(config_path)
+      msg = 'A valid dev environment configuration is required. Please provide a valid config,'\
+            "\r\n"\
+            'or run `skaffold init` to generate a skaffold.yaml configuration.'\
+            "\r\n"\
+            'See the `uffizzi dev start --help` page for supported configs and usage details.'
+
+      Uffizzi.ui.say_error_and_exit(msg) unless File.exist?(config_path)
+    end
+
+    def pid_path
+      File.join(Uffizzi::ConfigFile::CONFIG_DIR, 'uffizzi_dev.pid')
+    end
+
+    def logs_path
+      File.join(Uffizzi::ConfigFile::CONFIG_DIR, 'uffizzi_dev.log')
+    end
+
+    def build_skaffold_dev_command(config_path, options)
+      cmd = [
+        'skaffold dev',
+        "--filename='#{config_path}'",
+        "--default-repo='#{default_registry_repo(options[:'default-repo'])}'",
+        "--kubeconfig='#{default_kubeconfig_path(options[:kubeconfig])}'",
+      ]
+
+      cmd.join(' ')
+    end
+
+    def default_registry_repo(repo)
+      repo || DEFAULT_REGISTRY_REPO
+    end
+
+    def default_kubeconfig_path(kubeconfig_path)
+      path = kubeconfig_path || KubeconfigService.default_path
+
+      File.expand_path(path)
+    end
+  end
+end

data/lib/uffizzi/services/kubeconfig_service.rb

@@ -81,7 +81,9 @@ class KubeconfigService
     end
 
     def default_path
-      kubeconfig_env_path || Uffizzi.configuration.default_kubeconfig_path
+      path = kubeconfig_env_path || Uffizzi.configuration.default_kubeconfig_path
+
+      File.expand_path(path)
     end
 
     def read_kubeconfig(filepath)

data/lib/uffizzi/version.rb

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

data/lib/uffizzi.rb

@@ -36,5 +36,9 @@ module Uffizzi
     def root
       @root ||= Pathname.new(File.expand_path('..', __dir__))
     end
+
+    def process
+      @process ||= Process
+    end
   end
 end

data/man/uffizzi-dev-start

@@ -1,29 +1,99 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-DEV\-START" "" "September 2023" ""
+.TH "UFFIZZI\-DEV\-START" "" "October 2023" ""
 .SH "NAME"
-\fBuffizzi\-dev\-start\fR \- start development environment
+\fBuffizzi\-dev\-start\fR \- start a development environment
 .SH "SYNOPSIS"
 .nf
-uffizzi dev start [SKAFFOLD_CONFIG_FILE_PATH]
+uffizzi dev start [CONFIG_FILE] [FLAGS]
 .fi
 .SH "DESCRIPTION"
 .nf
-Creates a new cluster and start skaffold\. If no SKAFFOLD_CONFIG_FILE_PATH is specified,
-the default path will be used\.
-Default SKAFFOLD_CONFIG_FILE_PATH is \'skaffold\.yaml\'
+Creates a Uffizzi cluster preconfigured for development
+workflows, including building, pushing, and deploying
+your changes every time project files are saved\.
+current\-context is updated in kubeconfig file\.
+
+This command watches for file changes in a given local
+project directory, as specified in your configuration file\.
+It then serializes those changes and redeploys them onto
+a Uffizzi cluster\.
+
+The command looks for a configuration at the specified
+path CONFIG_FILE\. Skaffold configurations are currently
+supported\. For help creating a skaffold\.yaml file, see:
+https://skaffold\.dev/docs/init/
+
+If a kubeconfig exists
 
 For more information on Uffizzi clusters, see:
 https://docs\.uffizzi\.com/references/cli/
 .fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[CONFIG_FILE]
+    Path to the development environment configuration file\.
+    Currently supports skaffold\.yaml files\.
+.fi
+.SH "FLAGS"
+.nf
+ \-\-build="<local\-or\-remote>"
+    This option specifies whether to build images on the
+    local environment or on the remote Uffizzi cluster\.
+    Possible values are "local" or "remote"\.
+
+ \-\-default\-repo="<container\-registry\-domain>"
+    A public or private repo used to push/pull build
+    artifacts\. Overrides the global default image registry:
+    "registry\.uffizzi\.com"\. See `uffizzi connect \-h` for
+    adding private registry credentials\.
+
+ \-\-quiet, \-q
+    Run the development process in detached mode (i\.e\., in
+    the background)\. Without this option, logs are streamed
+    to the terminal in the foreground\. Run \'uffizzi dev stop`
+    to stop the detached process\.
+
+ \-\-help, \-h
+    Show this message and exit\.
+
+ \-\-kubeconfig="/path/to/your/kubeconfig"
+    Path to kubeconfig file\. If this option is not specified,
+    this command looks for the file at ~/\.kube/config\.
+.fi
 .SH "EXAMPLES"
 .nf
-To start development environment, run:
+If your configuration file is in the current working
+directory and you want to use an auto\-generated name,
+run:
 
     $ uffizzi dev start
 
-To start development environment with custom skaffold\.yaml file, run:
+To start a dev environment using a skaffold\.yaml config
+file in directory \'~/foo\', run:
+
+    $ uffizzi dev start ~/foo/skaffold\.yaml
+
+To start a dev environment in quiet  mode,
+run:
+
+    $ uffizzi dev start \-\-quiet
+
+To push your build artifacts to a private Docker Hub repo
+called \'acme/foo\', first add your Docker Hub credentials:
+
+    $ uffizzi connect docker\-hub
+    (See `uffizzi connect \-h` for other registry options)
+
+\|\.\|\.\|\.then override the default repo:
+
+    $ uffizzi dev start \e
+      \-\-default\-repo="hub\.docker\.com/acme/foo"
+
+To start a dev environment using an alternate kubeconfig file,
+run:
 
-    $ uffizzi cluster create /path/to/skaffold\.yaml
+    $ uffizzi dev start \e
+      \-\-kubeconfig="/path/to/alternate/kubeconfig"
 .fi
 

data/man/uffizzi-dev-start.ronn

@@ -1,22 +1,90 @@
-uffizzi-dev-start - start development environment
+uffizzi-dev-start - start a development environment
 ================================================================
 
 ## SYNOPSIS
-    uffizzi dev start [SKAFFOLD_CONFIG_FILE_PATH]
+    uffizzi dev start [CONFIG_FILE] [FLAGS]
 
 ## DESCRIPTION
-    Creates a new cluster and start skaffold. If no SKAFFOLD_CONFIG_FILE_PATH is specified,
-    the default path will be used.
-    Default SKAFFOLD_CONFIG_FILE_PATH is 'skaffold.yaml'
+    Creates a Uffizzi cluster preconfigured for development
+    workflows, including building, pushing, and deploying
+    your changes every time project files are saved.
+    current-context is updated in kubeconfig file.
+
+    This command watches for file changes in a given local
+    project directory, as specified in your configuration file.
+    It then serializes those changes and redeploys them onto
+    a Uffizzi cluster.
+
+    The command looks for a configuration at the specified
+    path CONFIG_FILE. Skaffold configurations are currently
+    supported. For help creating a skaffold.yaml file, see:
+    https://skaffold.dev/docs/init/
+
+    If a kubeconfig exists
 
     For more information on Uffizzi clusters, see:
     https://docs.uffizzi.com/references/cli/
 
+## POSITIONAL ARGUMENTS
+    [CONFIG_FILE]
+        Path to the development environment configuration file.
+        Currently supports skaffold.yaml files.
+
+## FLAGS
+     --build="<local-or-remote>"
+        This option specifies whether to build images on the
+        local environment or on the remote Uffizzi cluster.
+        Possible values are "local" or "remote".
+
+     --default-repo="<container-registry-domain>"
+        A public or private repo used to push/pull build
+        artifacts. Overrides the global default image registry:
+        "registry.uffizzi.com". See `uffizzi connect -h` for
+        adding private registry credentials.
+
+     --quiet, -q
+        Run the development process in detached mode (i.e., in
+        the background). Without this option, logs are streamed
+        to the terminal in the foreground. Run 'uffizzi dev stop`
+        to stop the detached process.
+
+     --help, -h
+        Show this message and exit.
+
+     --kubeconfig="/path/to/your/kubeconfig"
+        Path to kubeconfig file. If this option is not specified,
+        this command looks for the file at ~/.kube/config.
+
 ## EXAMPLES
-    To start development environment, run:
+    If your configuration file is in the current working
+    directory and you want to use an auto-generated name,
+    run:
 
         $ uffizzi dev start
 
-    To start development environment with custom skaffold.yaml file, run:
+    To start a dev environment using a skaffold.yaml config
+    file in directory '~/foo', run:
+
+        $ uffizzi dev start ~/foo/skaffold.yaml
+
+    To start a dev environment in quiet  mode,
+    run:
+
+        $ uffizzi dev start --quiet
+
+    To push your build artifacts to a private Docker Hub repo
+    called 'acme/foo', first add your Docker Hub credentials:
+
+        $ uffizzi connect docker-hub
+        (See `uffizzi connect -h` for other registry options)
+
+    ...then override the default repo:
+
+        $ uffizzi dev start \
+          --default-repo="hub.docker.com/acme/foo"
+
+    To start a dev environment using an alternate kubeconfig file,
+    run:
 
-        $ uffizzi cluster create /path/to/skaffold.yaml
+        $ uffizzi dev start \
+          --kubeconfig="/path/to/alternate/kubeconfig"

data/man/uffizzi-dev-stop

@@ -0,0 +1,41 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-DEV\-STOP" "" "October 2023" ""
+.SH "NAME"
+\fBuffizzi\-dev\-stop\fR \- stop a development environment
+.SH "SYNOPSIS"
+.nf
+uffizzi dev stop
+.fi
+.SH "DESCRIPTION"
+.nf
+Stops a dev environment and deletes the backing
+Uffizzi cluster resources, including any persistent
+volumes, and the namespace itself\. The Uffizzi
+cluster config is deleted from the kubeconfig file\.
+
+This command watches for file changes in a given local
+project directory, as specified in your configuration file\.
+It then serializes those changes and redeploys them onto
+a Uffizzi cluster\.
+
+The command looks for a configuration at the specified
+path CONFIG_FILE\. Skaffold configurations are currently
+supported\. For help creating a skaffold\.yaml file, see:
+https://skaffold\.dev/docs/init/
+
+For more information on Uffizzi clusters, see:
+https://docs\.uffizzi\.com/references/cli/
+.fi
+.SH "FLAGS"
+.nf
+ \-\-help, \-h
+    Show this message and exit\.
+.fi
+.SH "EXAMPLES"
+.nf
+To stop a dev environment, run:
+
+    $ uffizzi dev stop
+.fi
+

data/man/uffizzi-dev-stop.ronn

@@ -0,0 +1,33 @@
+uffizzi-dev-stop - stop a development environment
+================================================================
+
+## SYNOPSIS
+    uffizzi dev stop
+
+## DESCRIPTION
+    Stops a dev environment and deletes the backing
+    Uffizzi cluster resources, including any persistent
+    volumes, and the namespace itself. The Uffizzi
+    cluster config is deleted from the kubeconfig file.
+
+    This command watches for file changes in a given local
+    project directory, as specified in your configuration file.
+    It then serializes those changes and redeploys them onto
+    a Uffizzi cluster.
+
+    The command looks for a configuration at the specified
+    path CONFIG_FILE. Skaffold configurations are currently
+    supported. For help creating a skaffold.yaml file, see:
+    https://skaffold.dev/docs/init/
+
+    For more information on Uffizzi clusters, see:
+    https://docs.uffizzi.com/references/cli/
+
+## FLAGS
+     --help, -h
+        Show this message and exit.
+
+## EXAMPLES
+    To stop a dev environment, run:
+
+        $ uffizzi dev stop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -450,6 +450,7 @@ files:
 - lib/uffizzi/services/cluster_service.rb
 - lib/uffizzi/services/command_service.rb
 - lib/uffizzi/services/compose_file_service.rb
+- lib/uffizzi/services/dev_service.rb
 - lib/uffizzi/services/env_variables_service.rb
 - lib/uffizzi/services/github_service.rb
 - lib/uffizzi/services/kubeconfig_service.rb
@@ -521,6 +522,8 @@ files:
 - man/uffizzi-connect.ronn
 - man/uffizzi-dev-start
 - man/uffizzi-dev-start.ronn
+- man/uffizzi-dev-stop
+- man/uffizzi-dev-stop.ronn
 - man/uffizzi-disconnect
 - man/uffizzi-disconnect.ronn
 - man/uffizzi-login