diff options
| author |   Akhila Kishore <akhila.kishore@intel.com> | 2020-01-27 12:15:03 -0800 |
|---|---|---|
| committer | Akhila Kishore <akhila.kishore@intel.com> | 2020-02-26 14:25:16 -0800 |
| commit | 7e4e51d0355b6854795700209534d1566c85600f (patch) | |
| tree | 86069073013e207e75ecbc473a07211b0ed9e35d | |
| parent | c9c09d43c268d674b7567b4546020935fbd3c60d (diff) | |
Updating Readme to reflect accurate setup instructions
Adding sudo to setup for VM based deployment.
Additionally adding the link to Vagrant
documentation for CLI.
Signed-off-by: Akhila Kishore <akhila.kishore@intel.com>
Issue-ID: MULTICLOUD-908
Change-Id: I1af5b1c4e201ad4363a8fae1004189e55c514261
| -rw-r--r-- | docs/bare_metal_provisioning.rst | 2 | ||||
| -rw-r--r-- | docs/kud_architecture.rst | 8 | ||||
| -rw-r--r-- | kud/hosting_providers/vagrant/README.md | 10 |
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.  @@ -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/ |