aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRitu Sood <Ritu.Sood@intel.com>2020-02-29 01:38:30 +0000
committerGerrit Code Review <gerrit@onap.org>2020-02-29 01:38:30 +0000
commit7b566f2875230e15f79a6549b17240e767cc98f1 (patch)
treed80dda39fb38f1085ebcd0569c920f668f87657e
parent0fd6ec7e4956b03858d3d4351dcda37662b63d1d (diff)
parent7e4e51d0355b6854795700209534d1566c85600f (diff)
Merge "Updating Readme to reflect accurate setup instructions"
-rw-r--r--docs/bare_metal_provisioning.rst2
-rw-r--r--docs/kud_architecture.rst8
-rw-r--r--kud/hosting_providers/vagrant/README.md10
3 files changed, 13 insertions, 7 deletions
diff --git a/docs/bare_metal_provisioning.rst b/docs/bare_metal_provisioning.rst
index 885ffea3..4a7029b6 100644
--- a/docs/bare_metal_provisioning.rst
+++ b/docs/bare_metal_provisioning.rst
@@ -122,7 +122,7 @@ Nested-Virtualization.
**Deploying KUD services**
-Finally, the KRD provisioning process can be started through the use of
+Finally, the KUD provisioning process can be started through the use of
*installer.sh* bash script. The output of this script is collected in the
*kud_installer.log* file for future reference.
diff --git a/docs/kud_architecture.rst b/docs/kud_architecture.rst
index f56b72a5..2f724410 100644
--- a/docs/kud_architecture.rst
+++ b/docs/kud_architecture.rst
@@ -17,8 +17,8 @@ This document explains the different components of the Kubernetes
Reference Deployment project and how they can be configured to modify
its default behaviour.
-Vagranfile
-##########
+Vagrantfile
+###########
This file describes how the Virtual Machines are going to be
configured and the scripts and arguments used during their
@@ -127,7 +127,7 @@ setup.sh
########
This bash script is used for the installation and configuration of
-dependencies required for the usage of the KRD via Virtual Machines.
+dependencies required for the usage of the KUD via Virtual Machines.
Some of this dependencies are:
- `Vagrant <https://www.vagrantup.com/>`_,
@@ -138,7 +138,7 @@ and installed in the host machine.
.. code-block:: bash
- ./setup.sh -p libvirt
+ sudo ./setup.sh -p libvirt
Vagrant uses VirtualBox as default Virtualization provider. It's
possible to modify this behavior using the global enviroment variable
diff --git a/kud/hosting_providers/vagrant/README.md b/kud/hosting_providers/vagrant/README.md
index 00f0a70f..f0210149 100644
--- a/kud/hosting_providers/vagrant/README.md
+++ b/kud/hosting_providers/vagrant/README.md
@@ -4,7 +4,7 @@
This project offers a means for deploying a Kubernetes cluster
that satisfies the requirements of [ONAP multicloud/k8s plugin][1]. Its
-ansible playbooks allow to provision a deployment on Virtual Machines.
+ansible playbooks allow provisioning a deployment on Virtual Machines.
![Diagram](../../../docs/img/diagram.png)
@@ -21,16 +21,22 @@ Linux instructions to install dependencies and plugins required for
its usage. This script supports two Virtualization technologies
(Libvirt and VirtualBox).
- $ ./setup.sh -p libvirt
+ $ sudo ./setup.sh -p libvirt
Once Vagrant is installed, it's possible to provision a cluster using
the following instructions:
$ vagrant up && vagrant up installer
+In-depth documentation and use cases of various Vagrant commands [Vagrant commands][3]
+is available on the Vagrant site.
+
## License
Apache-2.0
[1]: https://git.onap.org/multicloud/k8s
+
[2]: https://www.vagrantup.com/
+
+[3]: https://www.vagrantup.com/docs/cli/