Add quickstart doc

Change-Id: I9b25af507124e8912f5328fd65c27df1186e36b4
This commit is contained in:
Proskurin Kirill 2016-09-02 16:08:19 +03:00
parent 2ae02fd7da
commit 97a1fec143
3 changed files with 77 additions and 16 deletions

View File

@ -1,15 +0,0 @@
Admin node
==========
This is a node where to run the installer. Admin node should be Ubuntu/Debian
based with the following packages installed:
* ansible (2.1.x),
* python-netaddr,
* sshpass,
* git.
The env var `$ADMIN_IP` determines where to run `admin_node_command` function
of the installer main script. When the `$ADMIN_IP` refers to a remote node,
like a VM, it should take an IP address. Otherwise, it should take the `local`
value.

View File

@ -12,8 +12,8 @@ Contents
.. toctree::
:maxdepth: 2
quickstart
host_requirements
admin_node
inventory_repo
packer
collect_info

76
doc/source/quickstart.rst Normal file
View File

@ -0,0 +1,76 @@
===========================
Kubernetes deployment guide
===========================
This guide provides a step by step instruction of how to deploy k8s cluster on
bare metal or a virtual machine.
k8s node requirements
=====================
The recommended deployment target requirements:
- At least 3 nodes running Ubuntu 16.04
- At least 8Gb of RAM per node
- At least 20Gb of disk space on each node.
Admin node requirements
=======================
This is a node where to run the installer. Admin node should be Debian/Ubuntu
based with the following packages installed:
* ansible (2.1.x)
* python-netaddr
* sshpass
* git
.. NOTE:: You could use one of the k8s node as an admin node. In this case this
node should meet both k8s and admin node requirements.
Node access requirements
========================
- Each node must have a user "vagrant" with a password "vagrant" created or
have access via ssh key.
- Each node must have passwordless sudo for "vagrant" user.
Deploy k8s cluster
==================
Clone fuel-ccp-installer repository:
::
git clone https://review.openstack.org/openstack/fuel-ccp-installer
Create deployment script:
::
cat > ~/deploy-k8s.sh << EOF
#!/bin/bash
set -ex
# CHANGE ADMIN_IP AND SLAVE_IPS TO MATCH YOUR ENVIRONMENT
export ADMIN_IP="10.90.0.2"
export SLAVE_IPS="10.90.0.2 10.90.0.3 10.90.0.4"
export DEPLOY_METHOD="kargo"
export WORKSPACE="~/workspace"
mkdir -p $WORKSPACE
cd ~/fuel-ccp-installer
bash -x "~/utils/jenkins/run_k8s_deploy_test.sh"
EOF
- ``ADMIN_IP`` - IP of the node which will run ansible. When the `$ADMIN_IP`
refers to a remote node, like a VM, it should take an IP address.
Otherwise, it should take the `local` value.
- ``SLAVE_IPS`` - IPs of the k8s nodes.
Run script:
::
bash ~/deploy-k8s.sh