1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-07 00:48:01 +01:00
Files
openshift-docs/modules/osdk-installing-cli.adoc
2019-03-19 08:21:41 -04:00

63 lines
1.6 KiB
Plaintext

// Module included in the following assemblies:
//
// * applications/operator_sdk/osdk-getting-started.adoc
// * applications/operator_sdk/osdk-ansible.adoc
// * applications/operator_sdk/osdk-helm.adoc
[id="osdk-installing-cli-{context}"]
= Installing the Operator SDK CLI
The Operator SDK has a CLI tool that assists developers in creating, building,
and deploying a new Operator project. You can install the SDK CLI on your
workstation so you are prepared to start authoring your own Operators.
.Prerequisites
- link:https://golang.github.io/dep/docs/installation.html[dep] v0.5.0+
- link:https://git-scm.com/downloads[Git]
- link:https://golang.org/dl/[Go] v1.10+
- link:https://docs.docker.com/install/[`docker`] v17.03+
- link:https://kubernetes.io/docs/tasks/tools/install-kubectl/[`kubectl`] v1.11.3+
- Access to a cluster based on Kubernetes v1.11.3+
- Access to a container registry
[NOTE]
====
This guide uses
link:https://github.com/kubernetes/minikube#installation[minikube] v0.25.0+ as
the local Kubernetes cluster and link:https://quay.io/[quay.io] for the public
registry.
====
.Procedure
. Clone and `operator-sdk` repository:
+
----
$ mkdir -p $GOPATH/src/github.com/operator-framework
$ cd $GOPATH/src/github.com/operator-framework
$ git clone https://github.com/operator-framework/operator-sdk
$ cd operator-sdk
----
. Check out the desired release branch:
+
----
$ git checkout master
----
. Install the SDK CLI tool:
+
----
$ make dep
$ make install
----
+
This installs the CLI binary `operator-sdk` at *_$GOPATH/bin_*.
. Verify that the CLI tool was installed correctly:
+
----
$ operator-sdk -h
----