redhat-cip/spinalstack-doc

Official manual of Spinal Stack

spinalstack-doc

Official manual of Spinal Stack

Contributing

You should not send pull-requests through GitHub and rather use our Software Factory's Gerrit instance.

1. Install git-review with apt, yum or pip

2. Login to Software Factory with your github account

3. Set-up gerrit in the project if it's the first time you're contributing to the project: with git review -s

4. Make your changes using the standard git workflow, commit in the end. (Note: It's better to make your changes in a feature branch git checkout -b <feature> and use one commit per review)

5. Submit your changes using git review and follow the link to see the reviews.

6. To propose another change, change back to the master branch and go back to step 4. You can also create a change linked to you latest change by staying on this change's branch but the new change(s) will depend on the old change and won't be merged until the first change has been merged.

spinalstack-doc's Issues

Improve Architecture section

http://spinalstack.enovance.com/en/latest/architecture.html

The Image is OK, but we need to explain it in a 'text' mode. We need to explain (again) that SpinalStack is just our way of deploying OpenStack. And that it requires some components to be downloaded (see Download section, github links, etc), and installed (see Deployment Guide section)

Thanks!

Download link / clarification

There are few explanations, unclear at least, about 'what is SpinalStack and How can it be downloaded'

It takes a couple of re-reads to understand that SpinalStack is not a product but a result of using eDeploy with our configurations and other scripts

I'll add a 'Download' item on the left menu, and explain this properly.
IMPORTANT: Refer to the Github link of eDeploy, and clarify the licensing consequences (if any)

Another improvement can be done in the Architecture section (see my other bug)

Fix typos in post-deployment

Wrong indent and more.

How jenkins intervenes in the deployment, with the 5 steps?

I don't fully understand the involved pieces described here:
http://spinalstack.enovance.com/en/latest/deploy/configuration.html#during-the-configuration

I thought Ansible was moving the system from one step to another, but it seems that is actually jenkins by checking serverspec to be OK, then launching the next step (how? shell? ansible jobs?) . But we do use Ansible via jenkins for upgrades, right? http://spinalstack.enovance.com/en/latest/deploy/upgrade.html

I haven't found any reference of this in the code (via grep)

Please develop further (maybe refer to the improved Architecture as described in another bug)

Add a post deployment guide

I think it will be nice to have a set of hook examples to configure the openstack after the initial deployment.
This could be a simple file that contains some generic commands, from the top of my head:

• create a public network
• change flavour properties
• change image properties
• commands to retrieve cloud images and add them