uffizzi-cli 2.3.3 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27943054f960693c2d1b8539a823f15f28e0f12d5e4763440cba3ee2f03f3412
-  data.tar.gz: 352f258d3a5a3d40b21e4d2c10d01028c4e16ec12a8902a3995cb3a64b687d1f
+  metadata.gz: 9881a62c56ed3ef3171721ef7e6f6374482f4068f268aa1f5a0b5864b6c8cec6
+  data.tar.gz: cc60bbc447f3f30759a74fa7fa916aab28134b9e05d97ecd1f0a69c8ba042cae
 SHA512:
-  metadata.gz: 025a64d8bc2e14ad93b21592d0b1ad5460e960019ef119fbf5afc78622317c0fb600f16fe4132f3bab6fb9c652176e4bae6a54ab49617db55e94f5c860238a1f
-  data.tar.gz: '09b7dfaab197c2aefe59cb187b570ce818d1fe2952f6545b3fccc432f05a4bdc75151f4f589d3d3abc65d8325f56dc3156a335ae41231e5d02815770b976e48d'
+  metadata.gz: 03c1494d690dd6bf8ef266cb815d08260bb0c609a22215f9e3ba8e9618a9598345c7161b6bdee18bafb5a45927f17c821239b069c50781a52420ab1746564a21
+  data.tar.gz: 847557bd05438144d2d964308a15dbc270105eb97c19c1971402e7b83c1ac82b90e611609ae0777ebd20f7e778e57ba0b4c1189db5c64c5a9fb58eefc3d6064e

data/README.md

@@ -1,178 +1,10 @@
 # Uffizzi CLI
 
-A command-line interace (CLI) for [Uffizzi App](https://github.com/UffizziCloud/uffizzi_app)
-
-## Uffizzi Overview
-
-Uffizzi is an open-source engine for creating lightweight, ephemeral test environments for APIs and full-stack applications. Uffizzi enables teams to preview new features before merging and to mitigate the risk of introducing regressions into a codebase. Each preview gets a shareable URL that's updated when you push new commits or image tags, so teams can provide continual feedback during the development/QA process. Previews can be configured to expire or be destroyed when a pull request is closed, so environments exist only as long as they are needed. Uffizzi also helps deconflict shared development environments since previews are deployed as isolated namespaces—there is no risk of clobbering another developer's preview.
-
-While Uffizzi depends on Kubernetes, it does not require end-users to interface with Kubernetes directly. Instead, Uffizzi leverages Docker Compose as its configuration file format, so developers do not need modify Kubernetes manifests or even know about Kubernetes.
-
-Uffizzi is designed to integrate with any CI/CD system.
-
-## Uffizzi Architecture
-<img src="https://github.com/UffizziCloud/uffizzi_app/blob/main/docs/images/uffizzi-architecture.png" description="Uffizzi Architecture" width="320"/>
-
-Uffizzi consists of the following components:
-
-- [Uffizzi App](https://github.com/UffizziCloud/uffizzi_app) - The primary REST API for creating and managing Previews
-- [Uffizzi Controller](https://github.com/UffizziCloud/uffizzi_controller) - A smart proxy service that handles requests from Uffizzi App to the Kubernetes API
-- Uffizzi CLI (this repository) - A command-line interface for Uffizzi App
-
-To host Uffizzi yourself, you will also need the following external dependencies:
-
-- Kubernetes (k8s) cluster
-- Postgres database
-- Redis cache
+A command-line interace (CLI) for the [Uffizzi API](https://github.com/UffizziCloud/uffizzi)
 
 ## Installation
 
-The Uffizzi CLI can be used interactively or as part of an automated workflow (e.g. GitHub Actions). Both options use the `uffizzi/cli` container image available on Docker Hub.
-
-### Interactive mode
-
-Run the CLI as a Docker container in interactive mode:
-```
-docker run --interactive --rm --tty --entrypoint=sh uffizzi/cli
-```
-
-If you specify the following environment variables, the Docker image's
-entrypoint script can log you into Uffizzi before executing your command.
-
-- `UFFIZZI_USER`
-- `UFFIZZI_SERVER`
-- `UFFIZZI_PASSWORD`
-- `UFFIZZI_PROJECT` (optional)
-
-### Automated mode
-
-If you want to use Uffizzi as part of an automated workflow, you can pass the Uffizzi commands to the Docker run command. For example:
-
-```
-docker run -it --rm uffizzi/cli project list
-```
-
-## Sample commands and examples
-
-### help
-
-The `help` subcommand can be used to see more information about a particular command.
-
-Examples:
-
-```
-uffizzi help
-```
-
-```
-uffizzi preview help
-```
-
-```
-uffizzi project compose help
-```
-
-### login
-
-```
-uffizzi login --server=localhost:8080 --username=your@email.com
-```
-
-Log in to the app with the specified server.
-
-#### login options
-
-| Option       | Aliase | Description               |
-| ------------ | ------ | ------------------------- |
-| `--username`     | `-u`   | Your email for logging in |
-| `--server` |        | The URL of the Uffizzi installation  |
-
-If server uses basic authentication you can specify options for it by setting `basic_auth_user` and `basic_auth_password` via `config set` command.
-
-### config
-
-Use this command to configure your cli app.
-
-```
-$ uffizzi config
-```
-
-Launching interactive setup guide that sets the values for `server`, `username` and `project`
-
-### config subcommands
-
-This command has 4 subcommands `list`, `get`, `set`, and `delete`.
-
-```
-uffizzi config list
-```
-
-Shows all options and their values from the config file.
-
-```
-uffizzi config get-value OPTION
-```
-
-Shows the value of the specified option.
-
-```
-uffizzi config set OPTION VALUE
-```
-
-Sets specified value for specified option. If a specified option already exists and has value it will be overwritten.
-
-```
-uffizzi config unset OPTION
-```
-
-Unsets specified option.
-
-### project
-
-```
-uffizzi project
-```
-
-Use this command to configure your projects. This command has 2 subcommands `list` and `compose`.
-
-```
-uffizzi project list
-```
-
-Shows all your projects' slugs
-
-If you have only one project it will be added to your config file automatically, if there's more than one project you need to set up your project manually with the commands `uffizzi config set YOUR_PROJECT_SLUG` or `uffizzi project set-default YOUR_PROJECT_SLUG`
-
-```
-$ uffizzi project set-default PROJECT_SLUG
-```
-Create a preview from a compose file.
-
-Sets the default project given with the given project slug. When set, all commands use this project as the default context unless overridden by the --project flag.
-
-### preview
-
-Create and manage previews
-
-```
-uffizzi preview create docker-compose.uffizzi.yml
-```
-Create a preview from a compose file.
-
-```
-uffizzi preview delete deployment-21
-```
-Delete a preview with preview ID `deployment-21`.
-
-### disconnect
-
-```
-uffizzi disconnect CREDENTIAL_TYPE
-```
-
-Deletes credential of specified type
-
-Supported credential types - `docker-hub`, `acr`, `ecr`, `gcr`
+See the [Uffizzi Documentation](https://docs.uffizzi.com) for installation instructions.
 
 ## Contributing
 

data/lib/uffizzi/cli/install.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+require 'uffizzi'
+require 'uffizzi/config_file'
+require 'uffizzi/services/kubeconfig_service'
+
+module Uffizzi
+  class Cli::Install < Thor
+    include ApiClient
+
+    default_task :controller
+
+    desc 'controller [HOSTNMAE]', 'Install uffizzi controller to cluster'
+    method_option :namespace, type: :string
+    method_option :email, type: :string, required: true
+    method_option :context, type: :string
+    method_option :issuer, type: :string, enum: ['letsencrypt', 'zerossl']
+    method_option :'repo-url', type: :string
+    def controller(hostname)
+      Uffizzi::AuthHelper.check_login
+
+      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
+
+      uri = parse_hostname(hostname)
+      installation_options = build_installation_options(uri)
+      check_existence_controller_settings(uri, installation_options)
+      helm_values = build_helm_values(installation_options)
+
+      InstallService.create_helm_values_file(helm_values)
+      helm_set_repo
+      InstallService.helm_install!(namespace)
+      InstallService.delete_helm_values_file
+      Uffizzi.ui.say('Helm release is deployed')
+
+      controller_setting_params = build_controller_setting_params(uri, installation_options)
+      create_controller_settings(controller_setting_params) if existing_controller_setting.blank?
+      Uffizzi.ui.say('Controller settings are saved')
+      say_success(uri)
+    end
+
+    private
+
+    def helm_set_repo
+      return if InstallService.helm_repo_search.present?
+
+      InstallService.helm_repo_add(options[:'repo-url'])
+    end
+
+    def build_installation_options(uri)
+      {
+        uri: uri,
+        controller_username: Faker::Lorem.characters(number: 10),
+        controller_password: generate_password,
+        cert_email: options[:email],
+        cluster_issuer: options[:issuer] || InstallService::DEFAULT_CLUSTER_ISSUER,
+      }
+    end
+
+    def wait_ip
+      spinner = TTY::Spinner.new('[:spinner] Waiting IP addess...', format: :dots)
+      spinner.auto_spin
+
+      ip = nil
+      try = 0
+
+      loop do
+        ip = InstallService.get_controller_ip(namespace)
+        break if ip.present?
+
+        if try == 30
+          spinner.error
+
+          return 'unknown'
+        end
+
+        try += 1
+        sleep(2)
+      end
+
+      spinner.success
+
+      ip
+    end
+
+    def wait_certificate_request_ready(uri)
+      spinner = TTY::Spinner.new('[:spinner] Waiting create certificate for controller host...', format: :dots)
+      spinner.auto_spin
+
+      try = 0
+
+      loop do
+        requests = InstallService.get_certificate_request(namespace, uri)
+        break if requests.all? { |r| r['status'].downcase == 'true' }
+
+        if try == 60
+          spinner.error
+
+          return Uffizzi.ui.say('Stop waiting creation certificate')
+        end
+
+        try += 1
+        sleep(2)
+      end
+
+      spinner.success
+    end
+
+    def build_helm_values(params)
+      {
+        global: {
+          uffizzi: {
+            controller: {
+              username: params[:controller_username],
+              password: params[:controller_password],
+            },
+          },
+        },
+        clusterIssuer: params.fetch(:cluster_issuer),
+        tlsPerDeploymentEnabled: true.to_s,
+        certEmail: params.fetch(:cert_email),
+        'ingress-nginx' => {
+          controller: {
+            ingressClassResource: {
+              default: true,
+            },
+          },
+        },
+        ingress: {
+          hostname: InstallService.build_controller_host(params[:uri].host),
+        },
+      }.deep_stringify_keys
+    end
+
+    def generate_password
+      hexatridecimal_base = 36
+      length = 8
+      rand(hexatridecimal_base**length).to_s(hexatridecimal_base)
+    end
+
+    def check_existence_controller_settings(uri, installation_options)
+      return if existing_controller_setting.blank?
+
+      Uffizzi.ui.say_error_and_exit('Installation canceled') unless update_and_continue?
+
+      controller_setting_params = build_controller_setting_params(uri, installation_options)
+      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"
+
+      Uffizzi.ui.say(msg)
+
+      question = 'Okay to proceed?'
+      Uffizzi.ui.say_error_and_exit('Installation canceled') unless Uffizzi.prompt.yes?(question)
+    end
+
+    def update_and_continue?
+      msg = "\r\n"\
+            'You already have installation controller params. '\
+            "\r\n"\
+            'You can update previous params and continue installation or cancel installation.'\
+            "\r\n"
+
+      Uffizzi.ui.say(msg)
+
+      question = 'Do you want update the controller settings?'
+      Uffizzi.prompt.yes?(question)
+    end
+
+    def fetch_controller_settings
+      response = get_account_controller_settings(server, account_id)
+      return Uffizzi::ResponseHelper.handle_failed_response(response) unless Uffizzi::ResponseHelper.ok?(response)
+
+      response.dig(:body, :controller_settings)
+    end
+
+    def update_controller_settings(controller_setting_id, params)
+      response = update_account_controller_settings(server, account_id, controller_setting_id, params)
+      Uffizzi::ResponseHelper.handle_failed_response(response) unless Uffizzi::ResponseHelper.ok?(response)
+    end
+
+    def create_controller_settings(params)
+      response = create_account_controller_settings(server, account_id, params)
+      Uffizzi::ResponseHelper.handle_failed_response(response) unless Uffizzi::ResponseHelper.created?(response)
+    end
+
+    def build_controller_setting_params(uri, installation_options)
+      {
+        url: URI::HTTPS.build(host: InstallService.build_controller_host(uri.host)).to_s,
+        managed_dns_zone: uri.host,
+        login: installation_options[:controller_username],
+        password: installation_options[:controller_password],
+      }
+    end
+
+    def say_success(uri)
+      ip_address = wait_ip
+      wait_certificate_request_ready(uri)
+
+      msg = 'Your Uffizzi controller is ready. To configure DNS,'\
+            " create a record for the hostname '*.#{uri.host}' pointing to '#{ip_address}'"
+      Uffizzi.ui.say(msg)
+    end
+
+    def parse_hostname(hostname)
+      uri = URI.parse(hostname)
+      host = uri.host || hostname
+
+      case uri
+      when URI::HTTP, URI::HTTPS
+        uri
+      else
+        URI::HTTPS.build(host: host)
+      end
+    end
+
+    def namespace
+      options[:namespace] || InstallService::DEFAULT_NAMESPACE
+    end
+
+    def server
+      @server ||= ConfigFile.read_option(:server)
+    end
+
+    def account_id
+      @account_id ||= ConfigFile.read_option(:account, :id)
+    end
+
+    def account_name
+      @account_name ||= ConfigFile.read_option(:account, :name)
+    end
+
+    def existing_controller_setting
+      @existing_controller_setting ||= fetch_controller_settings[0]
+    end
+  end
+end

data/lib/uffizzi/cli/uninstall.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'uffizzi'
+require 'uffizzi/config_file'
+require 'uffizzi/services/install_service'
+require 'uffizzi/services/kubeconfig_service'
+
+module Uffizzi
+  class Cli::Uninstall < Thor
+    include ApiClient
+
+    default_task :controller
+
+    desc 'controller [HOSTNMAE]', 'Install uffizzi controller to cluster'
+    method_option :namespace, type: :string
+    method_option :context, type: :string
+    def controller
+      Uffizzi::AuthHelper.check_login
+
+      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
+      delete_controller_settings
+      InstallService.helm_uninstall!(namespace)
+
+      helm_unset_repo
+    end
+
+    private
+
+    def helm_unset_repo
+      return if InstallService.helm_repo_search.blank?
+
+      InstallService.helm_repo_remove
+    end
+
+    def ask_confirmation
+      msg = "This command will uninstall Uffizzi from the '#{namespace}'"\
+            " namespace of the '#{InstallService.kubeconfig_current_context}' context."\
+            "\r\n"\
+            "To uninstall a different installation, use options '--namespace' and/or '--context'."\
+            "\r\n\r\n"\
+            "After uninstalling, new environments created for account '#{account_name}'"\
+            "\r\n"\
+            'will be deployed to Uffizzi Cloud (app.uffizzi.com).'\
+            "\r\n\r\n"
+
+      Uffizzi.ui.say(msg)
+
+      question = 'Okay to proceed?'
+      Uffizzi.ui.say_error_and_exit('Uninstallation canceled') unless Uffizzi.prompt.yes?(question)
+    end
+
+    def fetch_controller_settings
+      response = get_account_controller_settings(server, account_id)
+      return Uffizzi::ResponseHelper.handle_failed_response(response) unless Uffizzi::ResponseHelper.ok?(response)
+
+      response.dig(:body, :controller_settings)
+    end
+
+    def delete_controller_settings
+      return if existing_controller_setting.blank?
+
+      response = delete_account_controller_settings(server, account_id, existing_controller_setting[:id])
+
+      if ResponseHelper.no_content?(response)
+        Uffizzi.ui.say('Controller settings deleted')
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def namespace
+      options[:namespace] || InstallService::DEFAULT_NAMESPACE
+    end
+
+    def server
+      @server ||= ConfigFile.read_option(:server)
+    end
+
+    def account_id
+      @account_id ||= ConfigFile.read_option(:account, :id)
+    end
+
+    def account_name
+      @account_name ||= ConfigFile.read_option(:account, :name)
+    end
+
+    def existing_controller_setting
+      @existing_controller_setting ||= fetch_controller_settings[0]
+    end
+  end
+end

data/lib/uffizzi/cli.rb

@@ -75,6 +75,14 @@ module Uffizzi
     require_relative 'cli/dev'
     subcommand 'dev', Cli::Dev
 
+    desc 'install', 'install'
+    require_relative 'cli/install'
+    subcommand 'install', Cli::Install
+
+    desc 'uninstall', 'uninstall'
+    require_relative 'cli/uninstall'
+    subcommand 'uninstall', Cli::Uninstall
+
     map preview: :compose
 
     class << self

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

@@ -321,6 +321,34 @@ module ApiClient
     build_response(response)
   end
 
+  def get_account_controller_settings(server, account_id)
+    uri = account_controller_settings_uri(server, account_id)
+    response = http_client.make_get_request(uri)
+
+    build_response(response)
+  end
+
+  def create_account_controller_settings(server, account_id, params = {})
+    uri = account_controller_settings_uri(server, account_id)
+    response = http_client.make_post_request(uri, params)
+
+    build_response(response)
+  end
+
+  def update_account_controller_settings(server, account_id, id, params = {})
+    uri = account_controller_setting_uri(server, account_id, id)
+    response = http_client.make_put_request(uri, params)
+
+    build_response(response)
+  end
+
+  def delete_account_controller_settings(server, account_id, id)
+    uri = account_controller_setting_uri(server, account_id, id)
+    response = http_client.make_delete_request(uri)
+
+    build_response(response)
+  end
+
   private
 
   def http_client

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

@@ -139,4 +139,12 @@ module ApiRoutes
   def account_clusters_uri(server, account_id)
     "#{server}/api/cli/v1/accounts/#{account_id}/clusters"
   end
+
+  def account_controller_settings_uri(server, account_id)
+    "#{server}/api/cli/v1/accounts/#{account_id}/controller_settings"
+  end
+
+  def account_controller_setting_uri(server, account_id, id)
+    "#{server}/api/cli/v1/accounts/#{account_id}/controller_settings/#{id}"
+  end
 end

data/lib/uffizzi/services/install_service.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'uffizzi/response_helper'
+require 'uffizzi/clients/api/api_client'
+
+class InstallService
+  DEFAULT_HELM_RELEASE_NAME = 'uffizzi'
+  INGRESS_NAME = "#{DEFAULT_HELM_RELEASE_NAME}-controller"
+  DEFAULT_HELM_REPO_NAME = 'uffizzi'
+  DEFAULT_CONTROLLER_CHART_NAME = 'uffizzi-controller'
+  HELM_DEPLOYED_STATUS = 'deployed'
+  VALUES_FILE_NAME = 'helm_values.yaml'
+  DEFAULT_NAMESPACE = 'default'
+  DEFAULT_CLUSTER_ISSUER = 'letsencrypt'
+  DEFAULT_CONTROLLER_REPO_URL = 'https://uffizzicloud.github.io/uffizzi_controller'
+  DEFAULT_CONTROLLER_DOMAIN_PREFIX = 'controller'
+
+  class << self
+    include ApiClient
+
+    def kubectl_exists?
+      cmd = 'kubectl version -o json'
+      execute_command(cmd, say: false).present?
+    end
+
+    def helm_exists?
+      cmd = 'helm version --short'
+      execute_command(cmd, say: false).present?
+    end
+
+    def helm_repo_remove
+      cmd = "helm repo remove #{DEFAULT_HELM_REPO_NAME}"
+      execute_command(cmd, skip_error: true)
+    end
+
+    def helm_repo_search
+      cmd = "helm search repo #{DEFAULT_HELM_REPO_NAME}/#{DEFAULT_CONTROLLER_CHART_NAME} -o json"
+
+      execute_command(cmd) do |result, err|
+        err.present? ? nil : JSON.parse(result)
+      end
+    end
+
+    def helm_repo_add(repo_url)
+      repo_url = repo_url || DEFAULT_CONTROLLER_REPO_URL
+      cmd = "helm repo add #{DEFAULT_HELM_REPO_NAME} #{repo_url}"
+      execute_command(cmd)
+    end
+
+    def helm_install!(namespace)
+      Uffizzi.ui.say('Start helm release installation')
+
+      repo = "#{DEFAULT_HELM_REPO_NAME}/#{DEFAULT_CONTROLLER_CHART_NAME}"
+      cmd = "helm upgrade #{DEFAULT_HELM_RELEASE_NAME} #{repo}" \
+        " --values #{helm_values_file_path}" \
+        " --namespace #{namespace}" \
+        ' --create-namespace' \
+        ' --install' \
+        ' --output json'
+
+      res = execute_command(cmd, say: false)
+      info = JSON.parse(res)['info']
+
+      return if info['status'] == HELM_DEPLOYED_STATUS
+
+      Uffizzi.ui.say_error_and_exit(info)
+    end
+
+    def helm_uninstall!(namespace)
+      Uffizzi.ui.say('Start helm release uninstallation')
+
+      cmd = "helm uninstall #{DEFAULT_HELM_RELEASE_NAME} --namespace #{namespace}"
+
+      execute_command(cmd)
+    end
+
+    def set_current_context(context)
+      cmd = "kubectl config use-context #{context}"
+      execute_command(cmd)
+    end
+
+    def kubeconfig_current_context
+      cmd = 'kubectl config current-context'
+
+      execute_command(cmd, say: false) { |stdout| stdout.present? && stdout.chop }
+    end
+
+    def get_controller_ip(namespace)
+      cmd = "kubectl get ingress -n #{namespace} -o json"
+      res = execute_command(cmd, say: false)
+      ingress = JSON.parse(res)['items'].detect { |i| i['metadata']['name'] = INGRESS_NAME }
+
+      return if ingress.blank?
+
+      load_balancers = ingress.dig('status', 'loadBalancer', 'ingress')
+      return if load_balancers.blank?
+
+      load_balancers.map { |i| i['ip'] }[0]
+    end
+
+    def get_certificate_request(namespace, uri)
+      cmd = "kubectl get certificaterequests -n #{namespace} -o json"
+      res = execute_command(cmd, say: false)
+      certificate_request = JSON.parse(res)['items'].detect { |i| i['metadata']['name'].include?(uri.host) }
+
+      return [] if certificate_request.nil?
+
+      conditions = certificate_request.dig('status', 'conditions') || []
+      conditions.map { |c| c.slice('type', 'status') }
+    end
+
+    def build_controller_host(host)
+      [DEFAULT_CONTROLLER_DOMAIN_PREFIX, host].join('.')
+    end
+
+    def delete_helm_values_file
+      File.delete(helm_values_file_path) if File.exist?(helm_values_file_path)
+    end
+
+    def create_helm_values_file(values)
+      FileUtils.mkdir_p(helm_values_dir_path) unless File.directory?(helm_values_dir_path)
+      File.write(helm_values_file_path, values.to_yaml)
+    end
+
+    def helm_values_file_path
+      File.join(helm_values_dir_path, VALUES_FILE_NAME)
+    end
+
+    def helm_values_dir_path
+      File.dirname(Uffizzi::ConfigFile.config_path)
+    end
+
+    private
+
+    def execute_command(command, say: true, skip_error: false)
+      stdout_str, stderr_str, status = Uffizzi.ui.capture3(command)
+
+      return yield(stdout_str, stderr_str) if block_given?
+
+      if !status.success? && !skip_error
+        return Uffizzi.ui.say_error_and_exit(stderr_str)
+      end
+
+      if !status.success? && skip_error
+        return Uffizzi.ui.say(stderr_str)
+      end
+
+      say ? Uffizzi.ui.say(stdout_str) : stdout_str
+    rescue Errno::ENOENT => e
+      Uffizzi.ui.say_error_and_exit(e.message)
+    end
+  end
+end

data/lib/uffizzi/services/preview_service.rb

@@ -56,7 +56,9 @@ class PreviewService
 
       Uffizzi.ui.say('Deployed')
       Uffizzi.ui.say("Deployment url: https://#{deployment[:preview_url]}")
-      Uffizzi.ui.say("Deployment proxy url: https://#{deployment[:proxy_preview_url]}")
+      if deployment[:proxy_preview_url].present?
+        Uffizzi.ui.say("Deployment proxy url: https://#{deployment[:proxy_preview_url]}")
+      end
 
       activity_items
     rescue ApiClient::ResponseError => e

data/lib/uffizzi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uffizzi
-  VERSION = '2.3.3'
+  VERSION = '2.3.4'
 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" "" "October 2023" ""
+.TH "UFFIZZI" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\fR \- manage Uffizzi resources
 .SH "SYNOPSIS"

data/man/uffizzi-cluster

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER" "" "August 2023" ""
+.TH "UFFIZZI\-CLUSTER" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-cluster\fR \- manage clusters
 .SH "SYNOPSIS"
@@ -30,6 +30,12 @@ COMMAND is one of the following:
  list
     List all clusters
 
+ sleep
+    Put a cluster to sleep (non\-destructive)
+
+ wake
+    Wake a cluster that is sleeping
+
  update\-kubeconfig
     Update kubeconfig file
 .fi

data/man/uffizzi-cluster-create

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-CREATE" "" "October 2023" ""
+.TH "UFFIZZI\-CLUSTER\-CREATE" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-cluster\-create\fR
 .P

data/man/uffizzi-cluster-delete

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-DELETE" "" "September 2023" ""
+.TH "UFFIZZI\-CLUSTER\-DELETE" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-cluster\-delete\fR \- delete a cluster
 .SH "SYNOPSIS"

data/man/uffizzi-cluster-disconnect

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-CLUSTER\-DISCONNECT" "" "September 2023" ""
+.TH "UFFIZZI\-CLUSTER\-DISCONNECT" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-cluster\-disconnect\fR \- disconnect from current cluster context
 .SH "SYNOPSIS"

data/man/uffizzi-cluster-sleep

@@ -0,0 +1,39 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-CLUSTER\-SLEEP" "" "November 2023" ""
+.SH "NAME"
+\fBuffizzi\-cluster\-sleep\fR
+.P
+$ uffizzi cluster sleep \-h uffizzi\-cluster\-sleep \- put a cluster to sleep (non\-destructive) ================================================================
+.SH "SYNOPSIS"
+.nf
+uffizzi cluster sleep [CLUSTER_NAME]
+.fi
+.SH "DESCRIPTION"
+.nf
+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/
+.fi
+.SH "OPTIONS"
+.nf
+CLUSTER_NAME
+The name of the target Uffizzi cluster
+.fi
+.SH "EXAMPLES"
+.nf
+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
+.fi
+

data/man/uffizzi-cluster-wake

@@ -0,0 +1,37 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-CLUSTER\-WAKE" "" "November 2023" ""
+.SH "NAME"
+\fBuffizzi\-cluster\-wake\fR
+.P
+$ uffizzi cluster wake \-h uffizzi\-cluster\-wake \- wake a cluster that is sleeping ================================================================
+.SH "SYNOPSIS"
+.nf
+uffizzi cluster wake [CLUSTER_NAME]
+.fi
+.SH "DESCRIPTION"
+.nf
+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/
+.fi
+.SH "OPTIONS"
+.nf
+CLUSTER_NAME
+The name of the target Uffizzi cluster
+.fi
+.SH "EXAMPLES"
+.nf
+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
+.fi
+

data/man/uffizzi-dev

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

data/man/uffizzi-dev-delete

@@ -0,0 +1,33 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-DEV\-DELETE" "" "November 2023" ""
+.SH "NAME"
+\fBuffizzi\-dev\-delete\fR
+.P
+uffizzi dev delete \-h uffizzi\-dev\-delete \- delete a development environment ================================================================
+.SH "SYNOPSIS"
+.nf
+uffizzi dev delete
+.fi
+.SH "DESCRIPTION"
+.nf
+Deletes a dev environment and associated Uffizzi
+cluster resources, including any persistent
+volumes, and the namespace itself\. The Uffizzi
+cluster config is deleted from the kubeconfig file\.
+
+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 delete a dev environment, run:
+
+    $ uffizzi dev delete
+.fi
+

data/man/uffizzi-dev-describe

@@ -1,13 +1,13 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-DEV\-DESCRIBE" "" "October 2023" ""
+.TH "UFFIZZI\-DEV\-DESCRIBE" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-dev\-describe\fR
 .P
 $ uffizzi dev describe \-h uffizzi\-dev\-describe \- show metadata for a dev environment ================================================================
 .SH "SYNOPSIS"
 .nf
-uffizzi dev describe <NAME>
+uffizzi dev describe
 .fi
 .SH "DESCRIPTION"
 .nf
@@ -20,12 +20,6 @@ This command can fail for the following reasons:
 For more information on Uffizzi clusters, see:
 https://docs\.uffizzi\.com/references/cli/
 .fi
-.SH "POSITIONAL ARGUMENTS"
-.nf
-[NAME]
-    NAME for the dev environment you want to describe\.
-    This is an optional argument\.
-.fi
 .SH "EXAMPLES"
 .nf
 The following command prints metadata for the dev

data/man/uffizzi-dev-ingress

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-DEV\-INGRESS" "" "October 2023" ""
+.TH "UFFIZZI\-DEV\-INGRESS" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-dev\-ingress\fR
 .P

data/man/uffizzi-dev-ingress-open

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-DEV\-INGRESS\-OPEN" "" "October 2023" ""
+.TH "UFFIZZI\-DEV\-INGRESS\-OPEN" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-dev\-ingress\-open\fR
 .P

data/man/uffizzi-dev-start

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-DEV\-START" "" "October 2023" ""
+.TH "UFFIZZI\-DEV\-START" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-dev\-start\fR \- start a development environment
 .SH "SYNOPSIS"
@@ -24,8 +24,6 @@ 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
@@ -80,17 +78,6 @@ 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:
 

data/man/uffizzi-dev-stop

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-DEV\-STOP" "" "October 2023" ""
+.TH "UFFIZZI\-DEV\-STOP" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-dev\-stop\fR \- stop a development environment
 .SH "SYNOPSIS"
@@ -9,23 +9,11 @@ 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/
+Stops the skaffold process for the dev environment\.
+This command does not delete the dev cluster or any
+associated resources\. You can restart the dev environment
+with `uffizzi dev start`\. To delete the dev cluster entirely, see
+`uffizzi dev delete`\.
 .fi
 .SH "FLAGS"
 .nf

data/man/uffizzi-install

@@ -0,0 +1,57 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-INSTALL" "" "November 2023" ""
+.SH "NAME"
+\fBuffizzi\-install\fR
+.P
+$ uffizzi install help uffizzi\-install \- install the uffizzi platform ================================================================
+.SH "SYNOPSIS"
+.nf
+uffizzi install [HOSTNAME]
+.fi
+.SH "DESCRIPTION"
+.nf
+Install the Uffizzi platform on a host cluster\. By default, this command uses your
+kubeconfig current context as the host\.
+
+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\.
+
+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)\.
+
+EMAIL is a business email, required for letsencrypt cert authority\.
+
+For more information on the Uffizzi installation process, see:
+https://docs\.uffizzi\.com/cli/commands/install
+.fi
+.SH "FLAGS"
+.nf
+\-\-email
+    A business email required for letsencrypt
+
+ \-\-context
+    The name of the kubeconfig context to use
+
+ \-\-namespace
+    The namespace where Uffizzi platform will be installed
+
+\-\-help
+    Display this help page and exit
+.fi
+.SH "EXAMPLES"
+.nf
+To install Uffizzi using the current context at hostname
+\'uffizzi\.example\.com\', run:
+
+    $ 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" \e
+      \-\-context=\'foo\' \-\-namespace=\'bar\'
+.fi
+

data/man/uffizzi-install.ronn

@@ -0,0 +1,50 @@
+$ uffizzi install help
+uffizzi-install - install the uffizzi platform
+================================================================
+
+## SYNOPSIS
+    uffizzi install [HOSTNAME]
+
+## DESCRIPTION
+    Install the Uffizzi platform on a host cluster. By default, this command uses your
+    kubeconfig current context as the host.
+
+    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.
+
+    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).
+
+    EMAIL is a business email, required for letsencrypt cert authority.
+
+    For more information on the Uffizzi installation process, see:
+    https://docs.uffizzi.com/cli/commands/install
+
+## FLAGS
+
+    --email
+        A business email required for letsencrypt
+
+     --context
+        The name of the kubeconfig context to use
+
+     --namespace
+        The namespace where Uffizzi platform will be installed
+
+    --help
+        Display this help page and exit
+
+## EXAMPLES
+
+    To install Uffizzi using the current context at hostname
+    'uffizzi.example.com', run:
+
+        $ 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-login

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-LOGIN" "" "September 2023" ""
+.TH "UFFIZZI\-LOGIN" "" "November 2023" ""
 .SH "NAME"
 \fBuffizzi\-login\fR \- login to Uffizzi to view and manage your previews\.
 .SH "SYNOPSIS"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.3.4
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -426,6 +426,7 @@ files:
 - lib/uffizzi/cli/dev.rb
 - lib/uffizzi/cli/dev/ingress.rb
 - lib/uffizzi/cli/disconnect.rb
+- lib/uffizzi/cli/install.rb
 - lib/uffizzi/cli/login.rb
 - lib/uffizzi/cli/login_by_identity_token.rb
 - lib/uffizzi/cli/logout.rb
@@ -434,6 +435,7 @@ files:
 - lib/uffizzi/cli/project.rb
 - lib/uffizzi/cli/project/compose.rb
 - lib/uffizzi/cli/project/secret.rb
+- lib/uffizzi/cli/uninstall.rb
 - lib/uffizzi/clients/api/api_client.rb
 - lib/uffizzi/clients/api/api_routes.rb
 - lib/uffizzi/clients/api/http_client.rb
@@ -458,6 +460,7 @@ files:
 - lib/uffizzi/services/dev_service.rb
 - lib/uffizzi/services/env_variables_service.rb
 - lib/uffizzi/services/github_service.rb
+- lib/uffizzi/services/install_service.rb
 - lib/uffizzi/services/kubeconfig_service.rb
 - lib/uffizzi/services/preview_service.rb
 - lib/uffizzi/services/project_service.rb
@@ -486,9 +489,11 @@ files:
 - man/uffizzi-cluster-disconnect.ronn
 - man/uffizzi-cluster-list
 - man/uffizzi-cluster-list.ronn
+- man/uffizzi-cluster-sleep
 - man/uffizzi-cluster-sleep.ronn
 - man/uffizzi-cluster-update-kubeconfig
 - man/uffizzi-cluster-update-kubeconfig.ronn
+- man/uffizzi-cluster-wake
 - man/uffizzi-cluster-wake.ronn
 - man/uffizzi-cluster.ronn
 - man/uffizzi-compose
@@ -528,6 +533,7 @@ files:
 - man/uffizzi-connect-ghcr.ronn
 - man/uffizzi-connect.ronn
 - man/uffizzi-dev
+- man/uffizzi-dev-delete
 - man/uffizzi-dev-delete.ronn
 - man/uffizzi-dev-describe
 - man/uffizzi-dev-describe.ronn
@@ -542,6 +548,8 @@ files:
 - man/uffizzi-dev.ronn
 - man/uffizzi-disconnect
 - man/uffizzi-disconnect.ronn
+- man/uffizzi-install
+- man/uffizzi-install.ronn
 - man/uffizzi-login
 - man/uffizzi-login-by-identity-token
 - man/uffizzi-login-by-identity-token.html