doc fix: devstack setup doc can not display well

Let's use utf-8 encode.
Change md syntax to rst.

Change-Id: I417781692e198e4f9b073fcba44b5af3fa22b4ff
This commit is contained in:
Shaohe Feng 2018-05-29 14:32:33 +00:00
parent 38c1618e60
commit f2bbb73898
1 changed files with 82 additions and 74 deletions

View File

@ -2,97 +2,103 @@
DevStack Quick Start
====================
### Create stack user (optional)
Create stack user (optional)
----------------------------
Devstack should be run as a non-root user with sudo enabled (standard logins to
cloud images such as “ubuntu” or “cloud-user” are usually fine).
You can quickly create a separate stack user to run DevStack with.
You can quickly create a separate stack user to run DevStack with.
```bash
$ sudo useradd -s /bin/bash -d /opt/stack -m stack
```
`bash`
`$ sudo useradd -s /bin/bash -d /opt/stack -m stack`
Since this user will be making many changes to your system, it should have sudo
privileges:
```bash
$ echo "stack ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/stack
$ sudo su - stack
```
`bash`
### Download DevStack
`$ echo "stack ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/stack`
```
$ git clone https://git.openstack.org/openstack-dev/devstack
$ cd devstack
```
`$ sudo su - stack`
The `devstack` repo contains a script that installs OpenStack.
Download DevStack
-----------------
### Create local.conf file
`$ git clone https://git.openstack.org/openstack-dev/devstack`
Create a `local.conf` file at the root of the devstack git repo.
`$ cd devstack`
##### Host settings
The `devstack` repo contains a script that installs OpenStack.
```
[[local|localrc]]
# Multi-host settings
MULTI_HOST=False
HOST_IP=YOUR_IP_CONFIG
SERVICE_HOST=$HOST_IP
DATABASE_TYPE=mysql
MYSQL_HOST=$HOST_IP
RABBIT_HOST=$HOST_IP
```
Create local.conf file
----------------------
Create a `local.conf` file at the root of the devstack git repo.
Host settings
>>>>>>>>>>>>>
::
[[local|localrc]]
# Multi-host settings
MULTI_HOST=False
HOST_IP=YOUR_IP_CONFIG
SERVICE_HOST=$HOST_IP
DATABASE_TYPE=mysql
MYSQL_HOST=$HOST_IP
RABBIT_HOST=$HOST_IP
- Replace YOUR_IP_CONFIG with your host IP (e.g. 10.0.0.72 or localhost).
- If you are not configuring OpenStack env in multi-host settings, please set
MULTI_HOST=False.
##### Password settings
Password settings
>>>>>>>>>>>>>>>>>
```
# Passwords
DATABASE_PASSWORD=123
ADMIN_PASSWORD=123
MYSQL_PASSWORD=123
RABBIT_PASSWORD=123
SERVICE_PASSWORD=123
SERVICE_TOKEN=ADMIN
```
::
# Passwords
DATABASE_PASSWORD=123
ADMIN_PASSWORD=123
MYSQL_PASSWORD=123
RABBIT_PASSWORD=123
SERVICE_PASSWORD=123
SERVICE_TOKEN=ADMIN
- Pre-set the passwords to prevent interactive prompts.
##### Enable services
Enable services
>>>>>>>>>>>>>>>
```
#FIXED_RANGE=192.168.128.0/24
#IPV4_ADDRS_SAFE_TO_USE=192.168.128.0/24
#GIT_BASE=/opt/git
disable_service n-net
disable_service tempest
disable_service heat
enable_service q-svc
enable_service q-agt
enable_service q-dhcp
enable_service q-l3
enable_service q-meta
enable_service quantum
enable_service n-novnc
enable_plugin cyborg git://git.openstack.org/openstack/cyborg
NOVA_VNC_ENABLED=True
NOVNCPROXY_URL="http://$SERVICE_HOST:6080/vnc_auto.html"
VNCSERVER_LISTEN=0.0.0.0
VNCSERVER_PROXYCLIENT_ADDRESS=$SERVICE_HOST
RECLONE=False
#enable Logging
LOGFILE=/opt/stack/logs/stack.sh.log
VERBOSE=True
LOG_COLOR=True
LOGDIR=/opt/stack/logs
```
::
#FIXED_RANGE=192.168.128.0/24
#IPV4_ADDRS_SAFE_TO_USE=192.168.128.0/24
#GIT_BASE=/opt/git
disable_service n-net
disable_service tempest
disable_service heat
enable_service q-svc
enable_service q-agt
enable_service q-dhcp
enable_service q-l3
enable_service q-meta
enable_service quantum
enable_service n-novnc
enable_plugin cyborg git://git.openstack.org/openstack/cyborg
NOVA_VNC_ENABLED=True
NOVNCPROXY_URL="http://$SERVICE_HOST:6080/vnc_auto.html"
VNCSERVER_LISTEN=0.0.0.0
VNCSERVER_PROXYCLIENT_ADDRESS=$SERVICE_HOST
RECLONE=False
#enable Logging
LOGFILE=/opt/stack/logs/stack.sh.log
VERBOSE=True
LOG_COLOR=True
LOGDIR=/opt/stack/logs
- Uncomment GIT_BASE configuration if you have a local git repo
@ -103,26 +109,28 @@ LOGDIR=/opt/stack/logs
### Run DevStack
Run DevStack
------------
```
./stack.sh
```
`./stack.sh`
This will take a 30-40 minutes, largely depending on the speed of your internet
connection. Many git trees and packages will be installed during this process.
It will speed up your installation if you have a local GIT_BASE.
### Use OpenStack
Use OpenStack
-------------
##### Command line
Command line
>>>>>>>>>>>>
You can `source openrc YOUR_USER YOUR_USER (e.g. source openrc admin admin)` in
your shell, and then use the `openstack` command line tool to manage your
You can `source openrc YOUR_USER YOUR_USER (e.g. source openrc admin admin)` in
your shell, and then use the `openstack` command line tool to manage your
devstack.
##### Horizon
Horizon
>>>>>>>
You can access horizon to experience the web interface to OpenStack, and manage
vms, networks, volumes, and images from there.