Skip to content
Snippets Groups Projects
Verified Commit 2a8bdf3e authored by Josef Němec's avatar Josef Němec
Browse files

First Instance CLI guide

parent ffe2d3f2
No related branches found
No related tags found
1 merge request!43OpenStack CLI how-to
Pipeline #303475 passed with warnings
Stage: test
Stage: build_img
Stage: build
Stage: deploy
Stage: after_test
Hide whitespace changes
Inline Side-by-side
topics/compute/openstack/docs/getting-started/creating-first-infrastructure.md
+ 154
− 82
View file @ 2a8bdf3e
......@@ -18,6 +18,7 @@ Prerequisites:
* Up-to-date web browser
* Active account in [MetaCentrum](https://metavo.metacentrum.cz/en/application/index.html)
* Basic knowledge of SSH (for remote connections)
* [API key and CLI client](../how-to-guides/obtaining-api-key.md) (needed only if You want to use CLI)
## Sign In
......@@ -54,27 +55,43 @@ __5.__ Wait to be redirected back to our dashboard.
All virtual machine instances running in the cloud have to be accessed remotely. The most common way of accessing
an instance remotely is SSH. Using SSH requires a pair of keys - a public key and a private key.
__1.__ Navigate to **Project > Compute > Key Pairs** and click the **Create Key Pair** button.
=== "GUI"
!!! example
![](/compute/openstack/images/instance/keypair1.png)
__2.__ In the **Create key Pair** insert the **Key Pair Name**. Avoid using special characters, if possible. Next select SSH key for **Key Type** and finally confirm with **Done**.
!!! example
![](/compute/openstack/images/instance/keypair2.png)
__3.__ Download the private key to your local computer and move it to the `~/.ssh/` folder. If you are using windows, refer to [accessing from windows](../technical-reference/remote-access.md#accessing-from-windows).
__4.__ Set access privileges on `~/.ssh/` folder:
```
chmod 700 .ssh/
chmod 644 .ssh/id_rsa.pub
chmod 600 .ssh/id_rsa
```
__1.__ Navigate to **Project > Compute > Key Pairs** and click the **Create Key Pair** button.
!!! example
![](/compute/openstack/images/instance/keypair1.png)
__2.__ In the **Create key Pair** insert the **Key Pair Name**. Avoid using special characters, if possible. Next select SSH key for **Key Type** and finally confirm with **Done**.
!!! example
![](/compute/openstack/images/instance/keypair2.png)
__3.__ Download the private key to your local computer and move it to the `~/.ssh/` folder. If you are using windows, refer to [accessing from windows](../technical-reference/remote-access.md#accessing-from-windows).
__4.__ Set access privileges on `~/.ssh/` folder:
```
chmod 700 .ssh/
chmod 644 .ssh/id_rsa.pub
chmod 600 .ssh/id_rsa
```
=== "CLI"
You can use the **ssh-keygen** command to create a new private key:
```
ssh-keygen -b 4096
```
You will be asked to specify the output file and passphrase for your key.
Assuming your ssh public key is stored in `~/.ssh/id_rsa.pub`:
```
openstack keypair create --public-key ~/.ssh/id_rsa.pub my-key1
```
## Update Security Group
......@@ -85,81 +102,133 @@ You need to add at least one new rule to be able to connect to your new instance
This is similar to setting up firewall rules on your router or server. If set up correctly, you will be able to access
your virtual machine via SSH from your local terminal.
__1.__ Go to **Project > Network > Security Groups**. Click on **Manage Rules**, for the **default** security group.
!!! example
=== "GUI"
![](/compute/openstack/images/instance/sec_group1.png)
__2.__ Click on **Add rule**, choose **SSH**, and leave the remaining fields unchanged.
This will allow you to access your instance via IPv4.
!!! example
![](/compute/openstack/images/instance/sec_group2.png)
!!! caution
You have 2 possibilities for how to configure security groups policy.
- One is through CIDR which specifies rules for concrete network range.
- The second one specifies rules for members of a specified security group,
i.e. policy will be applied on instances that belong to the selected security group.
For details, refer to [the official documentation](https://docs.openstack.org/horizon/train/user/configure-access-and-security-for-instances.html).
__1.__ Go to **Project > Network > Security Groups**. Click on **Manage Rules**, for the **default** security group.
!!! example
![](/compute/openstack/images/instance/sec_group1.png)
__2.__ Click on **Add rule**, choose **SSH**, and leave the remaining fields unchanged.
This will allow you to access your instance via IPv4.
!!! example
![](/compute/openstack/images/instance/sec_group2.png)
!!! caution
You have 2 possibilities for how to configure security groups policy.
- One is through CIDR which specifies rules for concrete network range.
- The second one specifies rules for members of a specified security group,
i.e. policy will be applied on instances that belong to the selected security group.
For details, refer to [the official documentation](https://docs.openstack.org/horizon/train/user/configure-access-and-security-for-instances.html).
=== "CLI"
__1.__ Add SSH rule to the default security group:
```
openstack security group rule create --description "Permit SSH" --remote-ip 0.0.0.0/0 --protocol tcp --dst-port 22 --ingress default
```
Optionally, add ICMP rule (to allow ping):
```
openstack security group rule create --description "Permit ICMP (any)" --remote-ip 0.0.0.0/0 --protocol icmp --icmp-type -1 --ingress default
```
__2.__ Verify:
```
openstack security group show default
```
## Create Virtual Machine Instance
__1.__ In **Compute > Instances**, click the **Launch Instance** button.
!!! example
![](/compute/openstack/images/instance/instance1.png)
__2.__ Choose **Instance Name**, Description, and number of instances.
If you are creating more instances, `-%i` will be automatically appended to the name of each instance. Continue via **Next**
!!! example
![](/compute/openstack/images/instance/instance2.png)
__3.__ Choose an image from which to boot the instance. Choose to delete the volume after instance delete. This is not recommended for production deployment.
!!! example
![](/compute/openstack/images/instance/instance3.png)
__4.__ Choose the hardware resources of the instance by selecting a flavor. Additional volumes for data can be attached later on.
!!! example
![](/compute/openstack/images/instance/instance4.png)
__5.__ Select appropriate network based on your project type. and continue to **Key Pair** in the left menu.
=== "Personal project"
For personal project select personal-project-network-subnet from network `147-251-115-pers-proj-net`
=== "GUI"
__1.__ In **Compute > Instances**, click the **Launch Instance** button.
!!! example
![](/compute/openstack/images/instance/instance1.png)
__2.__ Choose **Instance Name**, Description, and number of instances.
If you are creating more instances, `-%i` will be automatically appended to the name of each instance. Continue via **Next**
!!! example
![](/compute/openstack/images/instance/instance2.png)
__3.__ Choose an image from which to boot the instance. Choose to delete the volume after instance delete. This is not recommended for production deployment.
!!! example
![](/compute/openstack/images/instance/instance3.png)
__4.__ Choose the hardware resources of the instance by selecting a flavor. Additional volumes for data can be attached later on.
!!! example
![](/compute/openstack/images/instance/instance4.png)
__5.__ Select appropriate network based on your project type. and continue to **Key Pair** in the left menu.
=== "Personal project"
For personal project select personal-project-network-subnet from network `147-251-115-pers-proj-net`
!!! example
![](/compute/openstack/images/instance/instance5.png)
=== "Group project"
For group project select group-project-network-subnet from network group-project-network (check if [Router gateway](../how-to-guides/create-networking.md#router-creation) is set)
!!! example
![](/compute/openstack/images/tutorial/instance_launch_network-group.png)
__6.__ In **Key Pair** select the key that was created in section [Create Key Pair](#create-key-pair) in the Available list and finally **Launch Instance**.
!!! example
![](/compute/openstack/images/instance/instance6.png)
![](/compute/openstack/images/instance/instance5.png)
=== "Group project"
=== "CLI"
For group project select group-project-network-subnet from network group-project-network (check if [Router gateway](../how-to-guides/create-networking.md#router-creation) is set)
__1.__ **Create volume**
!!! example
Volumes are created automatically when creating an instance in GUI, but we need to create them manually in the case of CLI.
Create bootable volume from image (e.g. centos):
```
openstack volume create --image "centos-7-1809-x86_64" --size 40 my_vol1
```
![](/compute/openstack/images/tutorial/instance_launch_network-group.png)
To get a list of available images:
```
openstack image list
```
__2.__ **Create instance**
```
openstack server create --flavor "standard.small" --volume my_vol1 \
--key-name my-key1 --security-group default --network 147-251-115-pers-proj-net my-server1
```
__6.__ In **Key Pair** select the key that was created in section [Create Key Pair](#create-key-pair) in the Available list and finally **Launch Instance**.
To get a list of available flavors:
```
openstack flavor list
```
!!! example
In case of a group project use `--network group-project-network`.
![](/compute/openstack/images/instance/instance6.png)
## Associate Floating IP
__9.__ Wait until instance initialization finishes and
Wait until instance initialization finishes and
[Associate Floating IP](../how-to-guides/managing-floating-ips.md).
For group project always select the same network as used in
[Router gateway](../how-to-guides/create-networking.md#router-creation).
......@@ -168,7 +237,10 @@ For group project always select the same network as used in
![](/compute/openstack/images/tutorial/instance_associate_ip.png)
__10.__ Login using your SSH key as selected in Key pair above
## Login
Login using your SSH key as selected in Key pair above
Connect to the instance using **ssh system@floating-ip**, as described on page [Accessing instances](../how-to-guides/accessing-instances.md).
......
topics/compute/openstack/docs/how-to-guides/command-line-interface.md deleted 100644 → 0
+ 0
− 88
View file @ ffe2d3f2
---
title: Command Line Interface
search:
exclude: false
---
# Command Line Interface
## Getting Application Credentials
In order to have access to OpenStack's API, you have to use so-called OpenStack Application Credentials. In short,
it is a form of token-based authentication providing easy and secure access without the use of passwords.
There is a comprehensive guide for [Obtaining API Key](../how-to-guides/obtaining-api-key.md).
## Create a key-pair
You can either get your private key from the dashboard or you can use **ssh-keygen** command to create a new private key:
```
ssh-keygen -b 4096
```
then you will be asked to specify the output file and passphrase for your key.
1. Assuming your ssh public key is stored in `~/.ssh/id_rsa.pub`
```
openstack keypair create --public-key ~/.ssh/id_rsa.pub my-key1
```
## Create a security group
1. Create:
```
openstack security group create my-security-group
```
2. Add rules to your security group:
```
openstack security group rule create --description "Permit SSH" --remote-ip 0.0.0.0/0 --protocol tcp --dst-port 22 --ingress my-security-group
openstack security group rule create --description "Permit ICMP (any)" --remote-ip 0.0.0.0/0 --protocol icmp --icmp-type -1 --ingress my-security-group
```
3. Verify:
```
openstack security group show my-security-group
```
## Create networking
Refer to the CLI section of [Create Networking](../how-to-guides/create-networking.md).
## Create router
Refer to the CLI section of [Create Router](../how-to-guides/create-router.md).
## Create volume
!!! caution
Skipping this section can lead to unreversible loss of data!
Volumes are created automatically when creating an instance in GUI, but we need to create them manually in the case of CLI
1. Create bootable volume from image(e.g. centos):
```
openstack volume create --image "centos-7-1809-x86_64" --size 40 my_vol1
```
## Create server
1. Create the instance:
```
openstack server create --flavor "standard.small" --volume my_vol1 \
--key-name my-key1 --security-group my-security-group --network my-net1 my-server1
```
## Floating IP address management
Refer to the CLI section of [Managing Floating IPs](../how-to-guides/managing-floating-ips.md).
## Cloud tools
You might want to manage resources [Using Cloud Tools](../additional-information/using-cloud-tools.md).
## Full Reference
See [OpenStack CLI Documentation](https://docs.openstack.org/python-openstackclient/train/).
\ No newline at end of file
topics/compute/openstack/mkdocs.yml
+ 0
− 1
View file @ 2a8bdf3e
......@@ -12,7 +12,6 @@ nav:
- how-to-guides/attaching-interface.md
# - how-to-guides/attaching-remote-storage.md
- how-to-guides/changing-vm-resources.md
- how-to-guides/command-line-interface.md
- how-to-guides/create-networking.md
- how-to-guides/create-router.md
- how-to-guides/deploying-loadbalancers.md
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment