bbcf22cc12
Sphinx and OpenStack documentation standards require the use of RST formatted documentation. In order to get out docs integrated into docs.openstack.org, the following steps must be taken: 1. we need to first convert the documentation to RST 2. sphinx support must be added to the repository 3. project-config must be updated with a publish-docs job The ability to pubish to docs.openstack.org is a privilege only available to Big Tent projects. As a result, we should be taking advantage of this to help spread the word on our implementation. Note the documentation was converted with a tool called pandoc the syntax of which was: pandoc -f markdown -t rst file.md > z mv z file.rst In order for git to preserve history the files have to be git mv'ed in one commit followed by the pandoc operation in a separate commit. Change-Id: Iba2a70b989e8305da03e8204a9b130d457b00cf0 |
||
|---|---|---|
| .. | ||
| ceilometer.yml | ||
| cinder-api-scheduler.yml | ||
| cinder-backup.yml | ||
| cinder-volume.yml | ||
| designate.yml | ||
| galeradb.yml | ||
| glance-api-registry.yml | ||
| gnocchi.yml | ||
| heat-api-engine.yml | ||
| horizon.yml | ||
| keepalived.yml | ||
| keystone.yml | ||
| magnum-api-conductor.yml | ||
| mariadb.yml | ||
| memcached.yml | ||
| murano-api-engine.yml | ||
| neutron-agents.yml | ||
| neutron-linuxbridge-agent.yml | ||
| neutron-server.yml | ||
| nova-api-compute-network.yml | ||
| nova-api-conductor-scheduler-consoleauth-novncproxy.yml | ||
| nova-compute-network.yml | ||
| nova-compute.yml | ||
| rabbitmq.yml | ||
| README.rst | ||
| swift-proxy.yml | ||
| swift-storage.yml | ||
Docker compose
These scripts and docker compose files can be used to stand up a simple installation of openstack. Running the 'tools/genenv' script creates an 'openstack.env' suitable for running on a single host system as well as an 'openrc' to allow access to the installation.
Once you have run that you can either manually start the containers using the 'docker-compose' command or try the 'tools/kolla-compose start' script which tries to start them all in a reasonable order, waiting at key points for services to become available. Once stood up you can issue the typical openstack commands to use the installation. If using nova networking use:
` # source openrc # tools/init-runonce # nova boot --flavor m1.medium --key_name mykey --image puffy_clouds instance_name # ssh cirros@<ip>`
Else if using neutron networking use:
` # source openrc # tools/init-runonce # nova boot --flavor m1.medium --key_name mykey --image puffy_clouds instance_name --nic net-id:<net id> # ssh cirros@<ip>`