You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
$ 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
uninstall
Uninstall the Uffizzi platform data plane from a host cluster. Updates CLI
to use Uffizzi Cloud as the default API.
uffizzi install -h help page
$ uffizzi install help
uffizzi-install - install the uffizzi platform
================================================================
## SYNOPSIS
uffizzi install [HOSTNAME] --email=[EMAIL]
## DESCRIPTION
Install the Uffizzi platform data plane (controller and operator) on a host cluster.
If you want to self-host the Uffizzi platform data and control planes, you should
use Uffizzi Enterprise instead. Contact sales@uffizzi.com to get started.
For more information on the Uffizzi installation process, see:
https://docs.uffizzi.com/install/platform
## POSITIONAL ARGUMENTS
HOSTNAME
The hostname where your installation will be publicly available. E.g. uffizzi.example.com
The output of the `install` 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.
EMAIL
A business email, required for letsencrypt certificate authority.
## FLAGS
--email
A business email required for letsencrypt
--context
The name of the kubeconfig context to use. If no context is specified, your
kubeconfig current context is used.
--namespace
The namespace where Uffizzi platform will be installed. If no namespace is
specified, the 'default' namespace is used.
--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'
uffizzi uninstall -h help page
$ uffizzi uninstall help
uffizzi-uninstall - uninstall the uffizzi platform
================================================================
## SYNOPSIS
uffizzi uninstall
## DESCRIPTION
Uninstall the Uffizzi platform data plane (controller and operator) from a host cluster.
For more information on the Uffizzi installation process, see:
https://docs.uffizzi.com/install/platform
## FLAGS
--help
Display this help page and exit
## EXAMPLES
To uninstall Uffizzi, run:
$ uffizzi uninstall
The text was updated successfully, but these errors were encountered:
gadkins
changed the title
Add uffizzi uninstall -h help page + add as command option to uffizzi -h
Add uffizzi uninstall -h help page + add install/uninstall as command options to uffizzi -hFeb 15, 2024
gadkins
changed the title
Add uffizzi uninstall -h help page + add install/uninstall as command options to uffizzi -h
Help pages for install and uninstallFeb 15, 2024
Summary
install
as command option touffizzi -h
uninstall
as command option touffizzi -h
uffizzi install -h
help pageuffizzi uninstall -h
help pageuffizzi -h
pageuffizzi install -h
help pageuffizzi uninstall -h
help pageThe text was updated successfully, but these errors were encountered: