README
¶
RHOAS CLI
rhoas is a command-line client for managing your application services on Kubernetes.
Installing RHOAS
See Installing the rhoas CLI for instructions on how to install CLI from official sources.
To install or update to latest version of CLI use following script:
curl -o- https://raw.githubusercontent.com/redhat-developer/app-services-cli/main/scripts/install.sh | bash
Guides
See our Guides for installation and usage instructions.
Commands
See the Command-Line Reference section for details of all available commands and options.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
pkg
|
|
|
cmd/kafka
Package kafka instance contains commands for interacting with cluster logic of the service directly instead of through the REST API exposed via the serve command.
|
Package kafka instance contains commands for interacting with cluster logic of the service directly instead of through the REST API exposed via the serve command. |
|
cmd/registry
Package registry REST API exposed via the serve command.
|
Package registry REST API exposed via the serve command. |
|
core/cmdutil/flagutil
Package flagutil is a helper package for processing and interactive command line flags
|
Package flagutil is a helper package for processing and interactive command line flags |
|
core/cmdutil/profile
This file contains functions that help to manage visibility of early stage commands
|
This file contains functions that help to manage visibility of early stage commands |
|
core/httputil
Package httputil contains functions that act as middleware for API interactions
|
Package httputil contains functions that act as middleware for API interactions |
|
core/ioutil/color
Color package is for printing a uniform set of colors for the CLI
|
Color package is for printing a uniform set of colors for the CLI |
|
core/ioutil/dump
Package dump contains functions used to print documents to JSON, YAML and Table formats
|
Package dump contains functions used to print documents to JSON, YAML and Table formats |
|
core/localize/goi18n
Internationalization implementation using nicksnyder/go-i18n
|
Internationalization implementation using nicksnyder/go-i18n |
|
shared/cluster
Cluster package provides way to work with RHOAS and Service binding operators Package will ofer integration with various RHOAS services Structure: v1alpha - end user API kubeclient - provides kubernetes clients service - individual service implementations Usage: cliProperties := v1alpha.CommandEnvironment{ IO: opts.IO, Logger: opts.Logger, Localizer: opts.localizer, Config: opts.Config, Connection: conn, } kubeClients, err := kubeclient.NewKubernetesClusterClients(&cliProperties, opts.kubeconfigLocation) if err != nil { return err } clusterAPI := cluster.KubernetesClusterAPIImpl{ KubernetesClients: kubeClients, CommandEnvironment: &cliProperties, } err = clusterAPI.ExecuteServiceBinding(&v1alpha.BindOperationOptions{ ServiceName: opts.serviceName, Namespace: opts.namespace, AppName: opts.appName, ForceCreationWithoutAsk: opts.forceCreationWithoutAsk, BindingName: opts.bindingName, BindAsFiles: !opts.bindAsEnv, DeploymentConfigEnabled: opts.deploymentConfigEnabled, }) Adding new service in "4 Simple Steps" ™ 1.
|
Cluster package provides way to work with RHOAS and Service binding operators Package will ofer integration with various RHOAS services Structure: v1alpha - end user API kubeclient - provides kubernetes clients service - individual service implementations Usage: cliProperties := v1alpha.CommandEnvironment{ IO: opts.IO, Logger: opts.Logger, Localizer: opts.localizer, Config: opts.Config, Connection: conn, } kubeClients, err := kubeclient.NewKubernetesClusterClients(&cliProperties, opts.kubeconfigLocation) if err != nil { return err } clusterAPI := cluster.KubernetesClusterAPIImpl{ KubernetesClients: kubeClients, CommandEnvironment: &cliProperties, } err = clusterAPI.ExecuteServiceBinding(&v1alpha.BindOperationOptions{ ServiceName: opts.serviceName, Namespace: opts.namespace, AppName: opts.appName, ForceCreationWithoutAsk: opts.forceCreationWithoutAsk, BindingName: opts.bindingName, BindAsFiles: !opts.bindAsEnv, DeploymentConfigEnabled: opts.deploymentConfigEnabled, }) Adding new service in "4 Simple Steps" ™ 1. |
Click to show internal directories.
Click to hide internal directories.