Skip to content

Commit

Permalink
Update the getting started guide
Browse files Browse the repository at this point in the history
  • Loading branch information
rmohr committed Mar 15, 2019
1 parent c119497 commit da92e99
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 14 deletions.
45 changes: 32 additions & 13 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,28 @@
A quick start guide to get KubeVirt up and running inside our container based
development cluster.

## I just want it built and run it on my cluser

First, point the `Makefile` to the docker registry of your choice:

```bash
export DOCKER_PREFIX=index.docker.io/myrepo
export DOCKER_TAG=mybuild
```

Then build the manifests and images:

```bash
make && make push
```

Finally push the manifests to your cluster:

```bash
kubectl create -f _out/manifests/release/kubevirt-operator.yaml
kubectl create -f _out/manifests/release/kubevirt-cr.yaml
```

## Building

The KubeVirt build system runs completely inside docker. In order to build
Expand Down Expand Up @@ -55,19 +77,6 @@ export KUBEVIRT_MEMORY_SIZE=8192M # node has 8GB memory size
make cluster-up
```

You could also run some build steps individually:

```bash
# To build all binaries
make

# Or to build just one binary
make build WHAT=cmd/virt-controller

# To build all kubevirt containers
make docker
```

To destroy the created cluster, type

```
Expand Down Expand Up @@ -237,3 +246,13 @@ to start a remote session with `remote-viewer`.
virtual machine specific commands with it and is a supplement to `kubectl`.
**Note:** If accessing your cluster through ssh, be sure to forward your X11 session in order to launch `virtctl vnc`.
### Bazel and KubeVirt
#### Build.bazel merge conflicts
You may encounter merge conflicts in `BUILD.bazel` files when creating pull
requests. Normally you can resolve these conflicts extremely easy by simply
accepting the new upstream version of the files and run `make` again. That will
update the build files with your changes.
2 changes: 1 addition & 1 deletion hack/bazel-fmt.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Copyright 2017 Red Hat, Inc.
# Copyright 2019 Red Hat, Inc.
#

set -e
Expand Down

0 comments on commit da92e99

Please sign in to comment.