diff options
| author |   Pawel Wieczorek <p.wieczorek2@samsung.com> | 2020-01-13 17:20:15 +0100 |
|---|---|---|
| committer | Pawel Wieczorek <p.wieczorek2@samsung.com> | 2020-01-13 17:48:51 +0100 |
| commit | 60e24054a7636e84ff6f3b074ec2c66364e1c01f (patch) | |
| tree | 85e5f9f34fea6bc79e01d768b9fad80ec46f3593 | |
| parent | 6efe941220c936d37fb5f7687d92af2e782c11ff (diff) | |
Add minimal Vagrant environment usage documentation
This patch also clarifies which virtual machines are created within this
Vagrant environment.
Issue-ID: ONAPARC-551
Change-Id: I2ece1bbf77b147c74f745ddfb26bf80143ac95ab
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
| -rw-r--r-- | bootstrap/vagrant-minimal-onap/README.rst | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/bootstrap/vagrant-minimal-onap/README.rst b/bootstrap/vagrant-minimal-onap/README.rst index 21238d732..2c214a94e 100644 --- a/bootstrap/vagrant-minimal-onap/README.rst +++ b/bootstrap/vagrant-minimal-onap/README.rst @@ -5,7 +5,7 @@ This directory contains a set of Vagrant scripts that will automatically set up: - Devstack, -- RKE-based Kubernetes cluster, +- RKE-based Kubernetes cluster (single control plane node and single worker plane node), - Operator's machine with configured tools (kubectl, helm). This is intended to show a beginning ONAP operator how to set up and configure an environment that @@ -82,3 +82,16 @@ useful in case there are multiple providers available. .. code-block:: sh vagrant up --provider=libvirt + + +Usage +----- + +Once ready (bringing up machines might initially take some time), tools for cluster management will +be available on Operator's machine. It can be accessed by executing: + +.. code-block:: sh + vagrant ssh operator + +Although appropriate context is set for `kubectl` on login, when interacting with the cluster the +`onap` namespace has to be explicitly specified. |