The object of this exercise is to learn how to automate the deployment of a cloud stack. In this case, it will be the same stack as deployed in the GUI tutorial.
Goal:
- Setup OpenStack's CLI
- Create a shell script that:
- Selects Flavour, Image, Sec. Group
- Create VM
- Select and Attach Floating IP
- Install Nginx
- Delete VM
For this we'll create two scripts - one for the creation of the VM, and a second for the deletion, although this could be only one script.
## Getting started
## Setup OpenStack's CLI
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
Before starting the installation, make sure you have Python and Pip installed in your computer.
## Add your files
*Installation*
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
If version number has been returned, then the installation is successful
-[ ] [Set up project integrations](https://gitedu.hesge.ch/lsds/teaching/bachelor/cloud-and-deployment/lab-os-cli/-/settings/integrations)
## Collaborate with your team
### Credential File
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Go to your project page, then in the menu on the left select Identity and then Application Credentials. Press 'Create Application Credentials' in the top right, and save it as `~/.config/openstack/clouds.yaml`. With SwitchEngines, the cloud name to use for this is engines.
## Test and Deploy
⚠️ App credentials might not work for some commands.
Use the built-in continuous integration in GitLab.
A template is also available in this repo file `conf/clouds.yaml.app_cred`. Alternatively, you can use your API credentials with explicit project name/ID -- you'll have to add your API password from your profile page's "Credentials" tab. A template is available in this repo file conf/clouds.yaml.api_cred.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
⚠️ Avoid mixing different authentication schemes in clouds.yaml or fromthe environment (via sourcing so called OpenStack RC files).
***
Verify that your credentials are OK (⚠ it might reveal secrets! f you have just one cloud configured, you can drop the switch --os-cloud=engines, else adapt accordingly):
# Editing this README
```bash
openstack --os-cloud=engines credential list
openstack --os-cloud=engines application credential list
```
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
⚠️ These commands might take a few seconds to complete. It is normal.
## Suggestions for a good README
## Shell Script
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
To remind you again of the goal of this exercise, you are to create a shell script which:
1. Create a VM
2. Install Nginx in the VM
3. Delete VM
## Name
Choose a self-explaining name for your project.
To aid you with this exercise, here is the link to a few examples of how to use the OpenStack CLI commands:
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
To list all available flavours:
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
```bash
openstack --os-cloud=engines flavor list
```
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
To list all available images:
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
```bash
openstack --os-cloud=engines image list
```
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
To list all the availables security groups:
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
```bash
openstack --os-cloud=engines security group list
```
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
To list all available key pairs:
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
```bash
openstack --os-cloud=engines keypair list
```
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
To start a VM we need to use the `nova` CLI.
The creation command is:
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
```bash
openstack server create --flavor FLAVOR_ID --image IMAGE_ID --key-name KEY_NAME \
--security-group SEC_GROUP_NAME \
INSTANCE_NAME
```
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
Then, to list the available instance:
## License
For open source projects, say how it is licensed.
```bash
openstack --os-cloud=engines server list
```
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
