uffizzi-cli 2.3.3 → 2.4.0

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,52 @@
+$ uffizzi -h
+uffizzi - manage Uffizzi resources
+================================================================
+
+## SYNOPSIS
+    uffizzi GROUP | COMMAND
+
+## DESCRIPTION
+    The uffizzi CLI manages authentication, configuration, and
+    interaction with Uffizzi APIs.
+
+    For more information on the uffizzi CLI, see:
+    https://docs.uffizzi.com/references/cli/
+
+## GROUP
+    GROUP is one of the following:
+     cluster
+         Manage virtual clusters
+
+     config
+         Configure the uffizzi CLI
+
+     connect
+         Grant a Uffizzi user account access to external services
+
+     compose
+         Manage Uffizzi compose environments (previews) and view logs
+
+     dev
+         Creates a Uffizzi cluster preconfigured for development workflows
+
+     install
+         Install the Uffizzi platform data plane on a host cluster.
+
+     project
+         Manage Uffizzi project resources including compose files for
+         specifying compose environment (preview) configurations and secrets
+
+## COMMAND
+    COMMAND is one of the following:
+
+     help
+         Show uffizzi documentation
+
+     login
+         Log in to a Uffizzi user account
+
+     logout
+         Log out of a Uffizzi user account
+
+     version
+         Print version information for uffizzi CLI

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.4.0
 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-12-18 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,8 @@ 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
 - lib/uffizzi/clients/api/http_client.rb
@@ -458,6 +461,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 +490,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 +534,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 +549,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