Quickstart: Difference between revisions

From MediaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Overview =
= Overview =
This page holds a short and concise guide to quickly get started within our OpenStack based cloud with either the [https://dashboard.stoney-cloud.com dashboard] or the command line interface (CLI).
<tabber>
|-|OpenStack CLI=
= OpenStack CLI Installation =
To use OpenStack CLI, you need to install the OpenStack CLI Client for your OS:
<syntaxhighlight lang="bash">
# Fedora
dnf install python3-openstackclient
# Debian / Ubuntu
apt install python3-openstackclient
</syntaxhighlight>
The official installaton guide can be found on [https://docs.openstack.org/mitaka/user-guide/common/cli_install_openstack_command_line_clients.html docs.openstack.org].
= OpenStack client environment script (OpenRC file) =
To increase efficiency of client operations, OpenStack supports simple client environment scripts also known as OpenRC files. These scripts typically contain common options for all clients, but also support unique options.
You may download such an OpenRC file from the [https://dashboard.stoney-cloud.com/ dashboard].
After logging into the [https://dashboard.stoney-cloud.com/ dashboard], click on your user name in the upper right corner and choose the menu option «OpenStack RC File v3» and save it the desired location on your local machine. As you can have multiple OpenRC files, we recommend to use a sub directory. For example <code>openrc</code> in your home directory.
[[Image:OpenStack_RC_File_v3.png|600px]]
Source the OpenRC file specific to this project (use single quotation marks to avoid problems with spaces in the file name):
<syntaxhighlight lang='bash'>
source ${HOME}/openrc/'Project Name-openrc.sh'
</syntaxhighlight>
After you sourced the file, you need to enter a password:
<syntaxhighlight lang="text">
Please enter your OpenStack Password for project Project Name as user user:
</syntaxhighlight>
Check if you have access to the OpenStack API by listing the API endpoints:
<syntaxhighlight lang='bash'>
openstack catalog list
</syntaxhighlight>
Expected output:
<syntaxhighlight lang='text'>
+------------+-----------+--------------------------------------------------------------------------------------------------+
| Name      | Type      | Endpoints                                                                                        |
+------------+-----------+--------------------------------------------------------------------------------------------------+
| glance    | image    | duedingen-production                                                                            |
|            |          |  internal: https://glance.ctrl-int.os.stoney-cloud.com:9292                                    |
|            |          | duedingen-production                                                                            |
|            |          |  public: https://api.os.stoney-cloud.com:9292                                                  |
|            |          | duedingen-production                                                                            |
|            |          |  admin: https://glance.ctrl-int.os.stoney-cloud.com:9292                                        |
[...]
| cinderv2  | volumev2  | duedingen-production                                                                            |
|            |          |  internal: https://cinder.ctrl-int.os.stoney-cloud.com:8776/v2/616812eda14e44de89138f3377841187 |
|            |          | duedingen-production                                                                            |
|            |          |  admin: https://cinder.ctrl-int.os.stoney-cloud.com:8776/v2/616812eda14e44de89138f3377841187    |
|            |          | duedingen-production                                                                            |
|            |          |  public: https://api.os.stoney-cloud.com:8776/v2/616812eda14e44de89138f3377841187              |
|            |          |                                                                                                  |
+------------+-----------+--------------------------------------------------------------------------------------------------+
</syntaxhighlight>
== Next steps ==
After gaining initial access using the OpenStack CLI you may continue by using stepping stone AG's OpenStack based cloud to the fullest:
[[:Category:Instances|Instances]]
* [[VM creation (Linux)]]
* [[VM creation (Windows)]]
* [[VM resize (Linux)]]
* [[VM resize (Windows)]]
* [[Flavor explanation]]
[[:Category:Volumes|Volumes]]
* [[Quota]]
[[:Category:Images|Images]]
* [[Image creation]]
[[:Category:Network|Network]]
* [[Security group rules]]
* [[IP usage]]
[[:Category:Object store|Object store]]
* [[S3 buckets]]
[[:Category:Kubernetes|Kubernetes]]
* [[Kubernetes management]]
* [[Kubernetes usage]]
[[:Category:Troubleshooting|Troubleshooting]]
* [[PCI workaround]]
* [[Change user password]]
|-|OpenStack Dashboard=
= Login via Dashboard =
Log in to the stoney cloud [https://dashboard.stoney-cloud.com/dashboard dashboard] with the credentials you have received from us.
[[File:Debian VM Creation Dashboard manual 01.png|600px]]
== Next steps ==
After gaining initial access to the OpenStack dashboard you may continue by using stepping stone AG's OpenStack based cloud to the fullest:
[[:Category:Instances|Instances]]
* [[VM creation (Linux)]]
* [[VM creation (Windows)]]
* [[VM resize (Linux)]]
* [[VM resize (Windows)]]
* [[Flavor explanation]]
[[:Category:Volumes|Volumes]]
* [[Quota]]
[[:Category:Images|Images]]
* [[Image creation]]
[[:Category:Network|Network]]
* [[Security group rules]]
* [[IP usage]]
[[:Category:Object store|Object store]]
* [[S3 buckets]]
[[:Category:Kubernetes|Kubernetes]]
* [[Kubernetes management]]
* [[Kubernetes usage]]
[[:Category:Troubleshooting|Troubleshooting]]
* [[PCI workaround]]
* [[Change user password]]
</tabber>
[[Category: CLI]]
[[Category: CLI]]
[[Category: Dashboard]]
[[Category: Dashboard]]

Latest revision as of 14:49, 28 October 2026

Overview

This page holds a short and concise guide to quickly get started within our OpenStack based cloud with either the dashboard or the command line interface (CLI).

OpenStack CLI Installation

To use OpenStack CLI, you need to install the OpenStack CLI Client for your OS:

# Fedora
dnf install python3-openstackclient
# Debian / Ubuntu
apt install python3-openstackclient

The official installaton guide can be found on docs.openstack.org.

OpenStack client environment script (OpenRC file)

To increase efficiency of client operations, OpenStack supports simple client environment scripts also known as OpenRC files. These scripts typically contain common options for all clients, but also support unique options.

You may download such an OpenRC file from the dashboard.

After logging into the dashboard, click on your user name in the upper right corner and choose the menu option «OpenStack RC File v3» and save it the desired location on your local machine. As you can have multiple OpenRC files, we recommend to use a sub directory. For example openrc in your home directory.

OpenStack RC File v3.png

Source the OpenRC file specific to this project (use single quotation marks to avoid problems with spaces in the file name):

source ${HOME}/openrc/'Project Name-openrc.sh'

After you sourced the file, you need to enter a password:

Please enter your OpenStack Password for project Project Name as user user:

Check if you have access to the OpenStack API by listing the API endpoints:

openstack catalog list

Expected output:

+------------+-----------+--------------------------------------------------------------------------------------------------+
| Name       | Type      | Endpoints                                                                                        |
+------------+-----------+--------------------------------------------------------------------------------------------------+
| glance     | image     | duedingen-production                                                                             |
|            |           |   internal: https://glance.ctrl-int.os.stoney-cloud.com:9292                                     |
|            |           | duedingen-production                                                                             |
|            |           |   public: https://api.os.stoney-cloud.com:9292                                                   |
|            |           | duedingen-production                                                                             |
|            |           |   admin: https://glance.ctrl-int.os.stoney-cloud.com:9292                                        |
[...]
| cinderv2   | volumev2  | duedingen-production                                                                             |
|            |           |   internal: https://cinder.ctrl-int.os.stoney-cloud.com:8776/v2/616812eda14e44de89138f3377841187 |
|            |           | duedingen-production                                                                             |
|            |           |   admin: https://cinder.ctrl-int.os.stoney-cloud.com:8776/v2/616812eda14e44de89138f3377841187    |
|            |           | duedingen-production                                                                             |
|            |           |   public: https://api.os.stoney-cloud.com:8776/v2/616812eda14e44de89138f3377841187               |
|            |           |                                                                                                  |
+------------+-----------+--------------------------------------------------------------------------------------------------+

Next steps

After gaining initial access using the OpenStack CLI you may continue by using stepping stone AG's OpenStack based cloud to the fullest:

Instances

Volumes

Images

Network

Object store

Kubernetes

Troubleshooting

Login via Dashboard

Log in to the stoney cloud dashboard with the credentials you have received from us.

Debian VM Creation Dashboard manual 01.png

Next steps

After gaining initial access to the OpenStack dashboard you may continue by using stepping stone AG's OpenStack based cloud to the fullest:

Instances

Volumes

Images

Network

Object store

Kubernetes

Troubleshooting