gofabric8 is used to validate & deploy fabric8 components on to your Kubernetes or OpenShift environment
Find more information at http://fabric8.io.
- Getting started
- Shell completion
Get the latest
gofabric8 or use the following script to download it.
curl -sS https://get.fabric8.io/download.txt | bash
Add '~/.fabric8/bin' to your path so you can execute the new binaries, for example: edit your ~/.zshrc or ~/.bashrc and append to the end of the file
export PATH=$PATH:~/.fabric8/bin source ~/.zshrc or ~/.bashrc
gofabric8 install installs the dependencies to locally run the fabric8
microservices platform - either minishift and openshift
client or minikube and kubectl along with necessary
drivers. The binaries are downloaded to
gofabric8 install --minishift
Install the fabric8 microservices platform
To install the fabric8 microservices platform then run the following:
If you are deploying to a remote OpenShift instance make sure to set the domain so we can generate routes to access applications
gofabric8 deploy --domain=your.domain.io
Reusing the Docker daemon
When developing locally and using a single VM its really handy to reuse the Docker daemon inside the VM; as this means you don't have to build on your host machine and push the image into a docker registry - you can just build inside the same docker daemon as minikube which speeds up local experiments.
To be able to work with the docker daemon on your mac/linux host use the docker-env command in your shell:
eval $(gofabric8 docker-env)
You should now be able to use docker on the command line on your host mac/linux machine talking to the docker daemon inside the minikube VM:
Remember to turn off the
imagePullPolicy:Always, as otherwise kubernetes won't
use images you built locally.
Run different versions
When deploying, by default the latest release version is used. In order to
deploy a specific version you can use the various
--version-xxxx flags as
gofabric8 deploy help
gofabric8 help gofabric8 is used to validate & deploy fabric8 components on to your Kubernetes or OpenShift environment Find more information at http://fabric8.io. Usage: gofabric8 [flags] gofabric8 [command] Available Commands: bdd-env Generates the BDD environment variables for use by the BDD test pipeline che Opens a shell in a Che workspace pod clean Clean up a resource type without deleting it completion Output shell completion code for the given shell (bash or zsh) console Open the fabric8 console copy-endpoints Copies endpoints from the current namespace to a target namespace create Create a resource type delete Delete a resource type deploy Deploy fabric8 to your Kubernetes or OpenShift environment docker-env Sets up docker env variables; Usage 'eval $(gofabric8 docker-env)' e2e Runs the end to end system tests e2e-console Points the jenkins namespace at the console to use for E2E tests e2e-env Generates the E2E environment variables for use by the E2E test pipeline e2e-secret Creates or updates a Secret for the user for E2E tests erase-pvc Erase PVC get Get a resource type ingress Creates any missing Ingress resources for services install Installs the dependencies to locally run the fabric8 microservices platform ip Returns the IP for the cluster gofabric8 is connected to log Tails the log of the newest pod for the given named Deployment or DeploymentConfig package-versions Displays the versions available for a package packages Lists the packages that are currently installed pull Pulls the docker images for the given templates routes Creates any missing Routes for services run Runs a fabric8 microservice from one of the installed templates secrets Set up Secrets on your Kubernetes or OpenShift environment service Opens the specified Kubernetes service in your browser start Starts a local cloud development environment status Gets the status of a local cluster stop Stops a running local cluster tenant Commands for working on your tenant test Runs the end to end system tests upgrade Upgrades the packages if there is a newer version available validate Validate your Kubernetes or OpenShift environment version Display version & exit volumes Creates a persisent volume for any pending persistance volume claims wait-for Waits for the listed deployments to be ready - useful for automation and testing Flags: --as string Username to impersonate for the operation -b, --batch export FABRIC8_BATCH=true Run in batch mode to avoid prompts. Can also be enabled via export FABRIC8_BATCH=true --certificate-authority string Path to a cert. file for the certificate authority --client-certificate string Path to a client certificate file for TLS --client-key string Path to a client key file for TLS --cluster string The name of the kubeconfig cluster to use --context string The name of the kubeconfig context to use --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kubeconfig string Path to the kubeconfig file to use for CLI requests. --match-server-version Require server version to match client version -n, --namespace string If present, the namespace scope for this CLI request --password string Password for basic authentication to the API server --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") -s, --server string The address and port of the Kubernetes API server --token string Bearer token for authentication to the API server --user string The name of the kubeconfig user to use --username string Username for basic authentication to the API server --version-console string fabric8 version (default "latest") --work-project string The work project (default "autodetect") -y, --yes Assume yes Use "gofabric8 [command] --help" for more information about a command.
gofabric8 provides shell completions, so you can easily complete commands while in the shell.
Simply add this to your
~/.bashrc if you use bash :
source <(gofabric8 completion bash)
or to your
~/.zshrc if you use zsh ::
source <(gofabric8 completion zsh)
Install go version 1.7.4
git clone email@example.com:fabric8io/gofabric8.git $GOPATH/src/github.com/fabric8io/gofabric8 make
Make changes to *.go files, rerun
make and execute the generated binary