aboutsummaryrefslogtreecommitdiff
path: root/devenv
diff options
context:
space:
mode:
authorSteven Dake <stdake@cisco.com>2015-08-21 02:05:23 -0700
committerSteven Dake <stdake@cisco.com>2015-08-21 15:17:01 -0700
commit2806e453b6f00797d673ac031de6cf5a05fe773e (patch)
tree78b4770a732e5d5442b850618892c1aeb27add8e /devenv
parentf14b229b1023c8808f07cdeedf875961bb923b0c (diff)
downloadkolla-2806e453b6f00797d673ac031de6cf5a05fe773e.tar.gz
kolla-2806e453b6f00797d673ac031de6cf5a05fe773e.zip
Rework documentaton to actually get people rolling
Individuals are beginning to evaluate Kolla and our quickstart documentation is in terrible terrible shape. Pleae just approve this change but do leave feedback. I will address changes in an iterative process in future patches rather then having a perfect documentation patch in one bang. Since this isn't code, there is not a high cost to refactoring or risk of regressions. Change-Id: I222cf15f4c5d748fb2daf3638094b4e7b35f8844
Diffstat (limited to 'devenv')
-rw-r--r--devenv/README.rst195
-rw-r--r--devenv/kollanet.pngbin26014 -> 0 bytes
2 files changed, 0 insertions, 195 deletions
diff --git a/devenv/README.rst b/devenv/README.rst
deleted file mode 100644
index 4436f4660..000000000
--- a/devenv/README.rst
+++ /dev/null
@@ -1,195 +0,0 @@
-A Kolla Cluster with Heat
-=========================
-
-These `Heat <https://wiki.openstack.org/wiki/Heat>`__ templates will
-deploy an *N*-node `Kolla <https://launchpad.net/kolla>`__ cluster,
-where *N* is the value of the ``number_of_nodes`` parameter you specify
-when creating the stack.
-
-Kolla has recently undergone a considerable design change. The details
-of the design change is addressed in this
-`spec <https://review.openstack.org/#/c/153798/>`__. As part of the
-design change, containers share pid and networking namespaces with the
-Docker host. Therefore, containers no longer connect to a docker0 bridge
-and have separate networking from the host. As a result, Kolla
-networking has a configuration similar to:
-
-.. figure:: https://raw.githubusercontent.com/stackforge/kolla/master/devenv/kollanet.png
- :alt: Image
-
- Image
-Sharing pid and networking namespaces is detailed in the `super
-privileged
-containers <http://sdake.io/2015/01/28/an-atomic-upgrade-process-for-openstack-compute-nodes/>`__
-concept.
-
-The Kolla cluster is based on Fedora 21, requires the minimum Docker
-version of 1.7.0
-`binary <https://docs.docker.com/installation/binaries/>`__.
-
-These templates are designed to work with the Icehouse or Juno versions
-of Heat. If using Icehouse Heat, this
-`patch <https://review.openstack.org/#/c/121139/>`__ is required to
-correct a bug with template validation when using the "Fn::Join"
-function).
-
-Create the Glance Image
-=======================
-
-After cloning the project, run the get-image.sh script from the
-project's devenv directory:
-
-::
-
- $ ./get-image.sh
-
-The script will create a Fedora 21 image with the required
-modifications.
-
-Add the image to your Glance image store:
-
-::
-
- $ glance image-create --name "fedora-21-x86_64" \
- --file /var/lib/libvirt/images/fedora-21-x86_64 \
- --disk-format qcow2 --container-format bare \
- --is-public True --progress
-
-Create the Stack
-================
-
-Copy local.yaml.example to local.yaml and edit the contents to match
-your deployment environment. Here is an example of a customized
-local.yaml:
-
-::
-
- parameters:
- ssh_key_name: admin-key
- external_network_id: 028d70dd-67b8-4901-8bdd-0c62b06cce2d
- container_external_network_id: 028d70dd-67b8-4901-8bdd-0c62b06cce2d
- container_external_subnet_id: 575770dd-6828-1101-34dd-0c62b06fjf8s
- dns_nameserver: 192.168.200.1
-
-The external\_network\_id is used by Heat to automatically assign
-floating IP's to your Kolla nodes. You can then access your Kolla nodes
-directly using the floating IP. The network ID is derived from the
-``neutron net-list`` command.
-
-The container\_external\_network\_id is used by the nova-network
-container within the Kolla node as the FLAT\_INTERFACE. The
-FLAT\_INTERFACE tells Nova what device to use (i.e. eth1) to pass
-network traffic between Nova instances across Kolla nodes. This network
-should be seperate from the external\_network\_id above and is derived
-from the 'neutron net-list' command.
-
-The container\_external\_subnet\_id: is the subnet equivalent to
-container\_external\_network\_id
-
-Review the parameters section of kollacluster.yaml for a full list of
-configuration options. **Note:** You must provide values for:
-
-- ``ssh_key_name``
-- ``external_network_id``
-- ``container_external_network_id``
-- ``container_external_subnet_id``
-
-And then create the stack, referencing that environment file:
-
-::
-
- $ heat stack-create -f kollacluster.yaml -e local.yaml kolla-cluster
-
-Access the Kolla Nodes
-======================
-
-You can get the ip address of the Kolla nodes using the
-``heat output-show`` command:
-
-::
-
- $ heat output-show kolla-cluster kolla_node_external_ip
- "192.168.200.86"
-
-You can ssh into that server as the ``fedora`` user:
-
-::
-
- $ ssh fedora@192.168.200.86
-
-Once logged into your Kolla node, setup your environment. The basic
-starting environment will be created using ``docker-compose``. This
-environment will start up the openstack services listed in the compose
-directory.
-
-To start, setup your environment variables.
-
-::
-
- $ cd kolla
- $ ./tools/genenv
-
-The ``genenv`` script will create a compose/openstack.env file and an
-openrc file in your current directory. The openstack.env file contains
-all of your initialized environment variables, which you can edit for a
-different setup.
-
-Next, run the start script.
-
-::
-
- $ ./tools/kolla-compose start
-
-The ``start`` script is responsible for starting the containers using
-``docker-compose -f <osp-service-container> up -d``.
-
-If you want to start a container set by hand use this template
-
-::
-
- $ docker-compose -f glance-api-registry.yml up -d
-
-Debugging
-=========
-
-All Docker commands should be run from the directory of the Docker
-binaray, by default this is ``/``.
-
-A few commands for debugging the system.
-
-::
-
- $ sudo ./docker images
-
-Lists all images that have been pulled from the upstream kollaglue
-repository thus far. This can be run on the node during the ``./start``
-operation to check on the download progress.
-
-::
-
- $ sudo ./docker ps -a
-
-This will show all processes that docker has started. Removing the
-``-a`` will show only active processes. This can be run on the node
-during the ``./start`` operation to check that the containers are
-orchestrated.
-
-::
-
- $ sudo ./docker logs <containerid>
-
-::
-
- $ curl http://<NODE_IP>:3306
-
-You can use curl to test connectivity to a container. This example
-demonstrates the Mariadb service is running on the node. Output should
-appear as follows
-
-::
-
- $ curl http://10.0.0.4:3306
- Trying 10.0.0.4...
- Connected to 10.0.0.4.
- Escape character is '^]'.
-
diff --git a/devenv/kollanet.png b/devenv/kollanet.png
deleted file mode 100644
index cfb0c6014..000000000
--- a/devenv/kollanet.png
+++ /dev/null
Binary files differ