Adding instructions to install Craton with Docker
Adding a new page with instructions to install using Docker Change-Id: I2b4598cb259b60f3fb00866f3f31156718778008 Closes-Bug: 1606861
This commit is contained in:
97
doc/source/docker-install.rst
Executable file
97
doc/source/docker-install.rst
Executable file
@@ -0,0 +1,97 @@
|
||||
|
||||
=======================
|
||||
Installing using Docker
|
||||
=======================
|
||||
|
||||
Installation
|
||||
============
|
||||
|
||||
-------------------------------------
|
||||
Installing necessary packages: Ubuntu
|
||||
-------------------------------------
|
||||
|
||||
|
||||
* Make sure git is installed::
|
||||
|
||||
$ sudo apt-get update
|
||||
$ sudo apt-get install git -y
|
||||
|
||||
* Clone the Craton repository::
|
||||
|
||||
$ git clone https://github.com/openstack/craton.git
|
||||
|
||||
* To install Docker, follow the instructions found here:
|
||||
https://docs.docker.com/engine/installation/linux/ubuntulinux/
|
||||
|
||||
|
||||
-------------------------------------------------
|
||||
Installing necessary packages: Fedora/CentOS etc.
|
||||
-------------------------------------------------
|
||||
|
||||
|
||||
* Install a fresh Fedora/CentOS image
|
||||
|
||||
* Make sure we have git installed::
|
||||
|
||||
$ sudo yum update
|
||||
$ sudo yum install git -y
|
||||
|
||||
* Clone the repository::
|
||||
|
||||
$ git clone https://github.com/openstack/craton.git
|
||||
|
||||
* Follow the correct Docker install guide for your operating system::
|
||||
|
||||
Fedora: https://docs.docker.com/engine/installation/linux/fedora/
|
||||
CentOS: https://docs.docker.com/engine/installation/linux/centos/
|
||||
|
||||
|
||||
---------------------------
|
||||
Run the Craton Docker Image
|
||||
---------------------------
|
||||
|
||||
* First, go to craton directory and build the Docker image::
|
||||
|
||||
$ sudo docker build -t craton-api .
|
||||
|
||||
* And finally, run the docker image::
|
||||
|
||||
$ sudo docker run craton-api -d
|
||||
|
||||
|
||||
-------------------
|
||||
Calling into Craton
|
||||
-------------------
|
||||
|
||||
* Now, let's run an API call against Craton running in the container. First, we need to enumerate the running Docker images::
|
||||
|
||||
$ sudo docker ps
|
||||
|
||||
* Use the container id from that command in this next command to find the container's IP address::
|
||||
|
||||
$ sudo docker inspect --format '{{ .NetworkSettings.IPAddress }}' ${ContainerId}
|
||||
|
||||
* Now that you know the IP address, you can run a curl command like the one below to query Craton::
|
||||
|
||||
$ curl -i "http://172.17.0.11:8080/v1/hosts?region=1" -H "Content-Type: application/json" -H "X-Auth-Token: demo" -H "X-Auth-User: demo" -H "X-Auth-Project: 1"
|
||||
|
||||
|
||||
|
||||
-------------------
|
||||
Command Cheat-Sheet
|
||||
-------------------
|
||||
|
||||
* Get the Craton logs::
|
||||
|
||||
$ docker logs -f craton-api
|
||||
|
||||
* Open mysql in the Craton container::
|
||||
|
||||
$ docker exec -it craton-api mysql -ucraton -pcraton craton
|
||||
|
||||
* Get a bash shell from the Craton container::
|
||||
|
||||
$ docker exec -it craton-api bash # for a bash shell, etc
|
||||
|
||||
|
||||
|
||||
@@ -2,19 +2,30 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
There are several ways that you can install Craton. If you're just
|
||||
getting started, it is recommended that you start with a Docker install.
|
||||
|
||||
Docker Install
|
||||
--------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
./docker-install
|
||||
|
||||
Basic Install
|
||||
-------------
|
||||
|
||||
(Optional) install virtualenv if desired::
|
||||
|
||||
$ mkvirtualenv craton
|
||||
$ pip install -r /craton/requirements.txt
|
||||
$ python setup.py install
|
||||
$ mkvirtualenv craton
|
||||
$ pip install -r /craton/requirements.txt
|
||||
$ python setup.py install
|
||||
|
||||
Setup Developer Environment
|
||||
Setup Developer Environment
|
||||
---------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
./dev/install
|
||||
./dev/install
|
||||
|
||||
Reference in New Issue
Block a user