Versions Compared

Old Version 13

changes.mady.by.user Lars Erik Pedersen

Saved on

compared with

New Version 14

changes.mady.by.user Lars Erik Pedersen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Introduction to the CLI clients

The openstack OpenStack CLI tools are available to all hosts which reside inside the cloud. The recommended entrypoint to start using these clients is to open an ssh client, and ssh to "skyhigh.hig.no" using your NTNU username and password. From that shell all openstack clients are available; and access to all floating IP's within the cloud.For CLI client access to stack.it.ntnu.no, from both the "ansatt" and "student" login shells at NTNU. SSH to either login.ansatt.ntnu.no or login.stud.ntnu.no (depending on you affiliation). The clients are available hereIf you're running a *nix version on your personal computer, you can install the OpenStack CLI locally, and use the CLI tools directly from your own computer.

It's also possible to run the CLI client driectly from WindwosWindows. (lightly tested) HOWTO guide here

Authentication

...

To download this script you should log into the webinterface and navigate to "COMPUTE -> Access & Security" and select the "API Access" tab. There a link to "Download Openstack RC File v3" can be found. Download this script:

Image Removed

...

to "Download Openstack RC File v3" can be found. Download this script:

Image Added

Image Added

Info

If you plan to run the CLI tools directly from your own computer, you can skip the steps regarding logging in to, and uploading the script to the login-shell. All the other examples and instructions applies for local usage as well.

When the script is downloaded, it should be uploaded over ssh to your home-folder at "skyhigh.higlogin.[ansatt|stud].ntnu.no", if you're not planning on running the CLI tools from your own computer. This can be done using your favorite scp client. In windows "FileZilla" would work fine, while in linux you can just use the commandline like so:

Code Block
eigil@mylaptop:~/Downloads$ scp PRIV_eigilo-openrc.sh eigilo@skyhigheigilo@login.ansatt.higntnu.no:.
eigilo@skyhigheigilo@login.ansatt.higntnu.no's password:
PRIV_eigilo-openrc.sh                             100% 1839   996.7KB/s   00:00

Next up is to log in to "skyhigh.higlogin.[ansatt|stud].ntnu.no" over SSH using your favorite ssh client. For windows you could use "putty", while linux and mac just can use the terminal. If your user is assigned to at least one openstack project you will be allowed into a machine called "access":

Code Block
eigil@mylaptop:~$ ssh eigilo@skyhigheigilo@login.ansatt.higntnu.no
eigilo@skyhigh.hig.no's password: 
ACCESS GRANTED - You have access to one or more OpenStack projects
eigilo@access:~$ eigilo@login.ansatt.ntnu.no's password: 
<snip...>
loginansatt01:~$

At this machine you should see the file you just uploaded, and to use the credentials from that file you should source it like so:

Code Block
eigilo@accessloginansatt01:~$ ls -l
total 4
-rw-r--r-- 1 eigilo users 1839 feb.   2 13:19 PRIV_eigilo-openrc.sh
eigilo@accessloginansatt01:~$ source PRIV_eigilo-openrc.sh 
Please enter your OpenStack Password for project PRIV_eigilo as user eigilo:

At this point, if you typed your password correctly, you should be able to use the openstack client. Test this with the command "openstack project show <your_projectname>". In case this command returns an HTTP401 error, it is likely that you typed your password wrong. Try to type it again by sourcing the script one more time:

Code Block
 eigilo@accessloginansatt01:~$ openstack project show PRIV_eigilo
The request you have made requires authentication. (HTTP 401) (Request-ID: req-ec807bd4-bd8e-416b-8e1b-bcaa541b1708)
eigilo@accessloginansatt01:~$ source PRIV_eigilo-openrc.sh 
Please enter your OpenStack Password for project PRIV_eigilo as user eigilo: 
eigilo@accessloginansatt01:~$ openstack project show PRIV_eigilo
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description | Eigil's private sandbox          |
| domain_id   | cb782810849b4ce8bce7f078cc193b19 |
| enabled     | True                             |
| id          | 2a4b680765554d728aa2f4d8aadab653 |
| is_domain   | False                            |
| name        | PRIV_eigilo                      |
| parent_id   | cb782810849b4ce8bce7f078cc193b19 |
+-------------+----------------------------------+

...

To have the openstack client giving you suggestions on whats valid command you could create an autocomplete file, save it as .bash_completion in your home-directory. Log out, and back in, and your openstack command will suggest what you would like to type when you click tab:

Code Block
eigilo@accessloginansatt01:~$ openstack complete > .bash_completion
eigilo@accessloginansatt01:~$ exit
Connection to skyhighlogin.ansatt.higntnu.no closed.
eigil@mylaptop:~/Downloads$ ssh eigilo@skyhigheigilo@login.ansatt.higntnu.no
eigilo@skyhigheigilo@login.ansatt.higntnu.no's password: 
Last login: Thu Feb 2 13:23:57 2017 from 128.39.142.103
ACCESS GRANTED - You have access to one or more OpenStack projects
eigilo@accessloginansatt01:~$ openstack <tab> <tab>
access consumer help object server
address container host orchestration service
aggregate credential hypervisor policy snapshot
availability domain identity port software
backup ec2 image project stack
catalog endpoint ip quota subnet
command extension keypair region token
complete federation limits request trust
compute flavor mapping role usage
configuration floating module router user
console group network security volume
eigilo@accessloginansatt01:~$ openstack

Creating an initial network topology

...

Creating this network is done trough the openstack command in two steps. First are the network created, with a name of your choice:

Code Block
eigilo@accessloginansatt01:~$ openstack network create MySecondNetwork
+-------------------------+--------------------------------------+
| Field                   | Value                                |
+-------------------------+--------------------------------------+
| admin_state_up          | UP                                   |
| availability_zone_hints |                                      |
| availability_zones      |                                      |
| created_at              | 2017-02-02T13:50:12Z                 |
| description             |                                      |
| headers                 |                                      |
| id                      | 73a1a530-dbdd-47cc-ab89-e5fa8a58aaf3 |
| ipv4_address_scope      | None                                 |
| ipv6_address_scope      | None                                 |
| mtu                     | 1500                                 |
| name                    | MySecondNetwork                      |
| project_id              | 2a4b680765554d728aa2f4d8aadab653     |
| project_id              | 2a4b680765554d728aa2f4d8aadab653     |
| revision_number         | 2                                    |
| router:external         | Internal                             |
| shared                  | False                                |
| status                  | ACTIVE                               |
| subnets                 |                                      |
| tags                    | []                                   |
| updated_at              | 2017-02-02T13:50:12Z                 |
+-------------------------+--------------------------------------+

...

In this example the network "10.14.2.0/24" is used:

Code Block
eigilo@accessloginansatt01:~$ openstack subnet create --subnet-range 10.14.2.0/24 --network MySecondNetwork MySecondSubnet-v4
+-------------------+--------------------------------------+
| Field             | Value                                |
+-------------------+--------------------------------------+
| allocation_pools  | 10.14.2.2-10.14.2.254                |
| cidr              | 10.14.2.0/24                         |
| created_at        | 2017-02-02T13:52:15Z                 |
| description       |                                      |
| dns_nameservers   |                                      |
| enable_dhcp       | True                                 |
| gateway_ip        | 10.14.2.1                            |
| headers           |                                      |
| host_routes       |                                      |
| id                | 10e400ab-bffe-4c3f-8f08-bec9d8e6a81a |
| ip_version        | 4                                    |
| ipv6_address_mode | None                                 |
| ipv6_ra_mode      | None                                 |
| name              | MySecondSubnet-v4                    |
| network_id        | 73a1a530-dbdd-47cc-ab89-e5fa8a58aaf3 |
| project_id        | 2a4b680765554d728aa2f4d8aadab653     |
| project_id        | 2a4b680765554d728aa2f4d8aadab653     |
| revision_number   | 2                                    |
| service_types     | []                                   |
| subnetpool_id     | None                                 |
| updated_at        | 2017-02-02T13:52:15Z                 |
+-------------------+--------------------------------------+

At this point the network is created, and this can be verified as so:

Code Block
 eigilo@access loginansatt01:~$ openstack network list
+-------------------------------+------------------------+-------------------------------+
| ID                            | Name                   | Subnets                       |
+-------------------------------+------------------------+-------------------------------+
| 22a507fa-                     | ntnu-internal          | 804a1172-0573-43e5-a042-93591 |
| ca51-4b57-bf84-784213917662   |                        | 4b8be7a                       |
| 73a1a530-dbdd-47cc-           | MySecondNetwork        | 10e400ab-bffe-4c3f-           |
| ab89-e5fa8a58aaf3             |                        | 8f08-bec9d8e6a81a             |
| 85cdb406-4b53-49d2-bde7-e9aff | MyInitialNetwork       | c25fae1e-9654-4364-b8fa-      |
| 441e869                       |                        | b9f7c50ede61                  |
+-------------------------------+------------------------+-------------------------------+

...

At this point the network is an isolated island within the cloud, an to give the network external acces a router is needed. Routers are created like this:

Code Block
eigilo@accessloginansatt01:~$ openstack router create MySecondRouter
+-------------------------+--------------------------------------+
| Field                   | Value                                |
+-------------------------+--------------------------------------+
| admin_state_up          | UP                                   |
| availability_zone_hints |                                      |
| availability_zones      |                                      |
| created_at              | 2017-02-02T13:56:18Z                 |
| description             |                                      |
| external_gateway_info   | null                                 |
| flavor_id               | None                                 |
| headers                 |                                      |
| id                      | 766936de-2c5f-44aa-8f38-2f13d6f701ae |
| name                    | MySecondRouter                       |
| project_id              | 2a4b680765554d728aa2f4d8aadab653     |
| project_id              | 2a4b680765554d728aa2f4d8aadab653     |
| revision_number         | 2                                    |
| routes                  |                                      |
| status                  | ACTIVE                               |
| updated_at              | 2017-02-02T13:56:18Z                 |
+-------------------------+--------------------------------------+

The router then needs to be given an external gateway. This is currently not possible to do trough the openstack clients, so the "neutron" client need to be used. See this article for an overview of which external networks are available at which cloud.

Code Block
eigilo@accessloginansatt01:~$ neutron router-gateway-set MySecondRouter ntnu-internal
Set gateway for router MySecondRouter

The router needs to be connected to the subnet like this:

Code Block
 eigilo@accessloginansatt01:~$ openstack router add subnet MySecondRouter MySecondSubnet-v4

...

There are 4 firewall rules which are present by default, and these rules allow outgoing traffic both for IPv4 and IPv6 and incoming traffic from other hosts using the same security group. These default settings would thus allow your virtual machines to communicate with each other in addition to accessing the internet. No incoming traffic is allowed per default.

Code Block
eigilo@accessloginansatt01:~$ openstack security group rule list default
+--------------------------+-------------+----------+------------+--------------------------+
| ID                       | IP Protocol | IP Range | Port Range | Remote Security Group    |
+--------------------------+-------------+----------+------------+--------------------------+
| 4638b4f3-b1b6-49d6-8a42- | None        | None     |            | 533a2023-35bb-41e2-adbc- |
| abee8fccb606             |             |          |            | d150d56250f0             |
| 829c6797-5978-4c72-854f- | None        | None     |            | None                     |
| de4d8b8dc32f             |             |          |            |                          |
| 9cd97ab3-9ece-           | None        | None     |            | None                     |
| 406f-8943-667eda08eed9   |             |          |            |                          |
| e633108d-0bb1-4ab5-ae7c- | None        | None     |            | 533a2023-35bb-41e2-adbc- |
| a82bcbe919f6             |             |          |            | d150d56250f0             |
+--------------------------+-------------+----------+------------+--------------------------+

...

  1. One rule to allow incoming SSH connections (TCP Port 22)
  2. One rule to allow incoming ICMP
Code Block
eigilo@accessloginansatt01:~$ openstack security group rule create --protocol tcp --ingress --dst-port 22 default
+-------------------+--------------------------------------+
| Field             | Value                                |
+-------------------+--------------------------------------+
| created_at        | 2017-02-02T14:24:22Z                 |
| description       |                                      |
| direction         | ingress                              |
| ethertype         | IPv4                                 |
| headers           |                                      |
| id                | 619ff756-3903-4543-b953-ba371988dd69 |
| port_range_max    | 22                                   |
| port_range_min    | 22                                   |
| project_id        | 2a4b680765554d728aa2f4d8aadab653     |
| project_id        | 2a4b680765554d728aa2f4d8aadab653     |
| protocol          | tcp                                  |
| remote_group_id   | None                                 |
| remote_ip_prefix  | 0.0.0.0/0                            |
| revision_number   | 1                                    |
| security_group_id | 533a2023-35bb-41e2-adbc-d150d56250f0 |
| updated_at        | 2017-02-02T14:24:22Z                 |
+-------------------+--------------------------------------+
eigilo@accessloginansatt01:~$ openstack security group rule create --protocol icmp --ingress  default
+-------------------+--------------------------------------+
| Field             | Value                                |
+-------------------+--------------------------------------+
| created_at        | 2017-02-02T14:24:44Z                 |
| description       |                                      |
| direction         | ingress                              |
| ethertype         | IPv4                                 |
| headers           |                                      |
| id                | 0ac41487-66ae-49f3-bc1a-13e3c8c57d76 |
| port_range_max    | None                                 |
| port_range_min    | None                                 |
| project_id        | 2a4b680765554d728aa2f4d8aadab653     |
| project_id        | 2a4b680765554d728aa2f4d8aadab653     |
| protocol          | icmp                                 |
| remote_group_id   | None                                 |
| remote_ip_prefix  | 0.0.0.0/0                            |
| revision_number   | 1                                    |
| security_group_id | 533a2023-35bb-41e2-adbc-d150d56250f0 |
| updated_at        | 2017-02-02T14:24:44Z                 |
+-------------------+--------------------------------------+

...

You could have openstack create a new keypair for you, and store the public key in the openstack database. The command returns the private-key, which should be stored in a file. It is smart to limit who have access to this file.

Code Block
eigilo@accessloginansatt01:~$ openstack keypair create MySecondKey > MySecondKey.priv
eigilo@accessloginansatt01:~$ chmod 600 MySecondKey.priv

...

To upload a key which already exists (for example ~/.ssh/id_rsa.pub) the following command can be used.

Code Block
eigilo@accessloginansatt01:~$ openstack keypair create MySecondExistingKey --public-key .ssh/id_rsa.pub
+-------------+------------------------------------------------------------------+
| Field       | Value                                                            |
+-------------+------------------------------------------------------------------+
| fingerprint | c7:16:40:92:63:c4:f3:07:bb:43:21:34:82:cb:e9:f8                  |
| name        | MySecondExistingKey                                              |
| user_id     | 1790de92c726dc409c223dcfed7fe2c67d792f3cf8e7f46118e5c2bfd63faff3 |
+-------------+------------------------------------------------------------------+

...

To create a virtual machine you need to decide how powerful it should be, and which image it should be based on. To list the various flavors and images you can use the following commands:

Code Block
eigilo@accessloginansatt01:~$ openstack image list
+--------------------------------------+-----------------------------------------+--------+
| ID                                   | Name                                    | Status |
+--------------------------------------+-----------------------------------------+--------+
| 8898ac64-09cd-4f93-a8e0-b6c761b0fbfb | Debian 8.7.0 (Jessie) stable amd64      | active |
   ...   Output is cut for brevity   ...
+--------------------------------------+-----------------------------------------+--------+
eigilo@accessloginansatt01:~$ openstack flavor list
+-------------------------------+------------+-------+------+-----------+-------+-----------+
| ID                            | Name       |   RAM | Disk | Ephemeral | VCPUs | Is Public |
+-------------------------------+------------+-------+------+-----------+-------+-----------+
| 0a4b6072-3170-447a-           | m1.tiny    |  1024 |   10 |         0 |     1 | True      |
| 8ac1-89562fd1c042             |            |       |      |           |       |           |
| 41272f0e-d3ff-4fe6-97eb-      | m1.xlarge  | 16384 |   80 |         0 |     8 | True      |
| 3d7e3b60f3fd                  |            |       |      |           |       |           |
| 7d7f1dfe-9af0-48ff-9ecf-      | m1.micro   |   512 |    5 |         0 |     1 | True      |
| 5b501a20b4cb                  |            |       |      |           |       |           |
| f0cc87d7-6683-474f-b1ea-      | m1.2xlarge | 32768 |  100 |         0 |    16 | True      |
| ef4a0660797f                  |            |       |      |           |       |           |
| f2cb5be9-2e41-4c96-a377-25e20 | m1.medium  |  4096 |   40 |         0 |     2 | True      |
| ca611ec                       |            |       |      |           |       |           |
| f5c05713-c2c0-471e-8664-46248 | m1.large   |  8192 |   60 |         0 |     4 | True      |
| 283a6af                       |            |       |      |           |       |           |
| fab9a8bf-8809-4780-90d9-e71e5 | m1.small   |  2048 |   20 |         0 |     1 | True      |
| 0ddf3d7                       |            |       |      |           |       |           |
+-------------------------------+------------+-------+------+-----------+-------+-----------+

The virtual server is then booted using this command:

Code Block
eigilo@accessloginansatt01:~$ openstack server create --image 8898ac64-09cd-4f93-a8e0-b6c761b0fbfb --flavor m1.medium --security-group default --key-name MySecondExistingKey --nic net-id=73a1a530-dbdd-47cc-ab89-e5fa8a58aaf3 MySecondServer
+--------------------------------------+----------------------------------------------------+
| Field                                | Value                                              |
+--------------------------------------+----------------------------------------------------+
| OS-DCF:diskConfig                    | MANUAL                                             |
| OS-EXT-AZ:availability_zone          |                                                    |
| OS-EXT-STS:power_state               | NOSTATE                                            |
| OS-EXT-STS:task_state                | scheduling                                         |
| OS-EXT-STS:vm_state                  | building                                           |
| OS-SRV-USG:launched_at               | None                                               |
| OS-SRV-USG:terminated_at             | None                                               |
| accessIPv4                           |                                                    |
| accessIPv6                           |                                                    |
| addresses                            |                                                    |
| adminPass                            | 54SSdRg3coxd                                       |
| config_drive                         |                                                    |
| created                              | 2017-02-02T14:47:24Z                               |
| flavor                               | m1.medium (f2cb5be9-2e41-4c96-a377-25e20ca611ec)   |
| hostId                               |                                                    |
| id                                   | 7fd211d6-ed7b-492a-89cf-1f3fe2cf3bdf               |
| image                                | Debian 8.7.0 (Jessie) stable amd64 (8898ac64-09cd- |
|                                      | 4f93-a8e0-b6c761b0fbfb)                            |
| key_name                             | MySecondExistingKey                                |
| name                                 | MySecondServer                                     |
| os-extended-volumes:volumes_attached | []                                                 |
| progress                             | 0                                                  |
| project_id                           | 2a4b680765554d728aa2f4d8aadab653                   |
| properties                           |                                                    |
| security_groups                      | [{u'name': u'default'}]                            |
| status                               | BUILD                                              |
| updated                              | 2017-02-02T14:47:25Z                               |
| user_id                              | 1790de92c726dc409c223dcfed7fe2c67d792f3cf8e7f46118 |
|                                      | e5c2bfd63faff3                                     |
+--------------------------------------+----------------------------------------------------+

If all is well, the machine should reach the "ACTIVE" state within seconds:

Code Block
 eigilo@accessloginansatt01:~$ openstack server list
+---------------------+----------------+--------+---------------------+---------------------+
| ID                  | Name           | Status | Networks            | Image Name          |
+---------------------+----------------+--------+---------------------+---------------------+
| 7fd211d6-ed7b-492a- | MySecondServer | ACTIVE | MySecondNetwork=10. | Debian 8.7.0        |
| 89cf-1f3fe2cf3bdf   |                |        | 14.2.12             | (Jessie) stable     |
|                     |                |        |                     | amd64               |
+---------------------+----------------+--------+---------------------+---------------------+

...

If this is the first time you use a floating IP, there are probably no IP allocated to your project. To allocate an IP to your project you could use the following command:

Code Block
eigilo@accessloginansatt01:~$ openstack floating ip create ntnu-internal
+---------------------+--------------------------------------+
| Field               | Value                                |
+---------------------+--------------------------------------+
| created_at          | 2017-02-02T14:52:46Z                 |
| description         |                                      |
| fixed_ip_address    | None                                 |
| floating_ip_address | 10.212.136.24                        |
| floating_network_id | 22a507fa-ca51-4b57-bf84-784213917662 |
| headers             |                                      |
| id                  | 1a90e802-5bc4-4997-b255-b2c942cfaa94 |
| port_id             | None                                 |
| project_id          | 2a4b680765554d728aa2f4d8aadab653     |
| project_id          | 2a4b680765554d728aa2f4d8aadab653     |
| revision_number     | 1                                    |
| router_id           | None                                 |
| status              | DOWN                                 |
| updated_at          | 2017-02-02T14:52:46Z                 |
+---------------------+--------------------------------------+

To show the floating IP's belonging to your project you could list them like so:

Code Block
 eigilo@accessloginansatt01:~$ openstack floating ip list
+------------------------+-----------------------+------------------+-------------------------+
| ID                     | Floating IP Address   | Fixed IP Address | Port                    |
+------------------------+-----------------------+------------------+-------------------------+
| 1a90e802-5bc4-4997-b25 | 10.212.136.21         | None             | None                    |
| 5-b2c942cfaa94         |                       |                  |                         |
| 5736b7eb-7934-4629     | 10.212.136.20         | 10.14.1.105      | 635637c2-b1ca-4759      |
| -921c-8d9cbda9c0af     |                       |                  | -8c5b-e7711c667138      |
+------------------------+-----------------------+------------------+-------------------------+

To assign a floating IP to a virtual machine, you would use the following command:

Code Block
eigilo@accessloginansatt01:~$ openstack server add floating ip MySecondServer 10.212.136.21

At this point you should be able to ping the server:

Code Block
eigilo@accessloginansatt01:~$ ping 10.212.136.21
PING 10.212.136.21 (10.212.136.21) 56(84) bytes of data.
64 bytes from 10.212.136.21: icmp_seq=1 ttl=62 time=3.23 ms
64 bytes from 10.212.136.21: icmp_seq=2 ttl=62 time=1.03 ms
^C
--- 10.212.136.21 ping statistics ---
2 packets transmitted, 2 received, 0% packet loss, time 1001ms
rtt min/avg/max/mdev = 1.032/2.135/3.238/1.103 ms

And you should be able to log into it, using the private part of the key selected when the server were booted:

Code Block
eigilo@accessloginansatt01:~$ ssh debian@10.212.136.21 -i .ssh/id_rsa
The authenticity of host '10.212.136.21 (10.212.136.21)' can't be established.
ECDSA key fingerprint is SHA256:PIR85mFU0TiOZ0mXHz1ExMvds1D1YO1eF+/TTniAYfo.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '10.212.136.21' (ECDSA) to the list of known hosts.
The programs included with the Debian GNU/Linux system are free software;
the exact distribution terms for each program are described in the
individual files in /usr/share/doc/*/copyright.
Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
permitted by applicable law.
debian@mysecondserver:~$