Skip to content
Snippets Groups Projects
Verified Commit 01faafad authored by Boris Parak's avatar Boris Parak :8ball:
Browse files

Updated logos + tweaked `quickstart` section

parent 058145c3
No related branches found
No related tags found
No related merge requests found
File moved
# Quickstart
Quickstart aims on users, which want to spin virtual machine in cloud as fast an possible.
To create and gain acces to virtual machine you need to:
* Login to MetaCloud
* Upload/create ssh keys
* Start the virtual machine
* Login to instance
## 1. Login to MetaCloud
1. One of the access options is the web interface that is available at [https://cloud.muni.cz](https://cloud.muni.cz). We recommend using the English version of the interface. The Czech translation of individual terms is not yet sufficiently experienced and their use may complicate communication with technical support. Use the following credentials to log in:
2. **Domain -** UCN
3. **User Name -** UČO[^1]@ucn.muni.cz
4. **Password -** your secondary password.
> Please note that you need to access OpenStack from within the internal university network. You can either use the two available networks - [eduroam and MUNI](https://it.muni.cz/en/services/wireless-wi-fi-connection "How to connect to Masaryk University network") or setup a [VPN access](https://it.muni.cz/en/services/vpn "How to setup a VPN access.").
>
> **TODO** add login info and screenshots
## 2. Import/create SSH keys
Quickstart is intended for users that want to spin up a virtual machine in the cloud as fast as possible.
To create a virtual machine, you need to
* sign in to the MetaCentrum cloud web interface,
* create an *ssh* key pair,
* set up security groups,
* start a virtual machine,
* log in to the running instance using *ssh*.
## 1. Sign in to the MetaCentrum cloud web interface
The web interface is available at [https://cloud.muni.cz](https://cloud.muni.cz). We recommend using the English version of the interface.
To sign in,
* select `ENIFRA CESNET`,
* click `Sign In`,
* select your institution from the drop-down list (use search box at the top as a filter),
* provide your institution-specific sign-in credentials,
* wait to be redirected back to our web interface.
## 2. Create an SSH key pair
To create a first instance accessible from the network you typically need to go through a few one-time steps that are not required later on. The first step is to create/import SSH keys.
1. To create a new SSH key, go to **Project > Compute > Key Pairs** and click the button "Create Key Pair"
1. To create a new SSH key pair, go to **Project > Compute > Key Pairs** and click the button "Create Key Pair"
{% reveal text="Click here to show a screenshot" %}
![](/0-quickstart/Create Key Pair.png)
![](/0-quickstart/CreateKeyPair.png)
{% endreveal %}
2. Name your new key and hit "Create Key Pair" again. Try to avoid special characters if possible.
2. Name your new key and click on "Create Key Pair" again. Avoid using special characters, if possible.
{% reveal text="Click here to show a screenshot" %}
![](/0-quickstart/CreateKeyPair2.png)
{% endreveal %}
3. You can see your newly created key pair and its fingerprint. Your browser will automatically save your key pair in your designated download location. We recommend you save it in a safe location and back it up andin case you accidentally delete it.
3. You can see your newly created key pair and its fingerprint. We recommend you save it in a safe location and back it up in case you accidentally delete it.
{% reveal text="Click here to show a screenshot" %}
![](/0-quickstart/CreateKeyPair3.png)
{% endreveal %}
## 3. Set-up Security Groups
All network traffic is blocked in OpenStack by default. You need to explicitly grant access to individual services by utilising Security Groups. This is similar to setting up firewall rules on your router or server. If setup correctly, you can access your virtual machine via SSH connection from your terminal.[^2]
## 3. Set up Security Groups
In OpenStack, all incoming network traffic is blocked by default. You need to explicitly grant access to individual virtual machines by utilizing the concept of security groups. You need to add two new rules to be able to connect to your new instance (or any instance using the given security group). 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 connection from your local terminal.
1. Go to **Project > Networks > Security Groups** You can see a default security group. You can either create a new one or edit the default by hitting "Manage Rules"
1. Go to **Project > Networks > Security Groups** You can see a default security group. You can either create a new one or edit the default group by clicking on "Manage Rules".
{% reveal text="Click here to show a screenshot" %}
![](/0-quickstart/SecurityGroups1.png)
{% endreveal %}
2. Next you need to add two new rules to be able to connect to your new instance. Hit the button "Add rule", give it a name and choose "ALL ICMP". Leave the rest of the fields unchanged.
2. Click on the button "Add rule", give the rule a name and choose "ALL ICMP". Leave the rest of the fields unchanged.
{% reveal text="Click here to show a screenshot" %}
![](/0-quickstart/SecurityGroups3.png)
{% endreveal %}
......@@ -58,27 +56,12 @@ All network traffic is blocked in OpenStack by default. You need to explicitly g
{% endreveal %}
## 4. Start a virtual machine
1. To spin up a new virtual machine, navigate to **Project > Compute > Instances** and hit the button "Launch Instance"
1. To spin up a new virtual machine, navigate to **Project > Compute > Instances** and click on the "Launch Instance" button.
2. Choose a name for your virtual machine.
3. From the drop-down menu, choose **"Image"** as a source and select an operating system that you desire to run on your instance.
4. Choose a suitable configuration of RAM/CPUS/Disk space, also known as a Flavor.
4. Choose a suitable configuration of RAM/CPUs/Disk space, also known as a flavor.
5. Add a virtual network for your instance.
6. You can leave the rest of the fields unchanged.
## 5. Assign a public IP address
To access your machine from the internet, you need to allocate a new public IP address to your project. Once the IP is allocated, you canthen assign it to a specific instance.
1. In the left menu, navigate to **Project** > **Network > Floating IPs** and hit the button "**Allocate IP To Project**".
2. Select "public-float-21" and hit the button "**Allocate IP**".
3. The last step is to assign the IP to your selected instance. Find the instance you want and hit the "Associate Floating IP" in the last section of the row titled "**Actions**".
4. Finally simply select the allocated IP and you're done.
## 6. Login to a virtual machine
## 5. Log in to a virtual machine
> **TODO** add steps how to login to VM
[^1]: University unique identification number
[^2]: Please note that you still need to have your SSH key present on your local machine.
0-quickstart/SecurityGroups1.png

146 KiB

0-quickstart/SecurityGroups2.png

204 KiB

0-quickstart/SecurityGroups3.png

202 KiB

......@@ -21,7 +21,7 @@ You can interact with OpenStack using your command line. This is the preferred o
> **TODO** manual install + some docker shizz?
## Access to Metacloud via CLI
## Access to MetaCentrum Cloud via CLI
> **TODO** add token access info
......
......@@ -2,7 +2,7 @@
## I want to use OpenStack. How do I register?
First thing you need to do is to sign up at MetaCenter and create an account. Use this [link](https://perun.metacentrum.cz/fed/registrar/?vo=meta&group=metacloud).
First thing you need to do is to sign up at MetaCenter and create an account. Use this [link](https://perun.metacentrum.cz/fed/registrar/?vo=meta&group=MetaCentrum Cloud).
## I have an issue with OpenStack. Where do I report it?
......
# Welcome to MetaCloud Documentation
# Welcome to MetaCentrum Cloud Documentation
Cloud infrastructure provides an environment for running your own virtual servers or whole virtual environments as a service. This infrastructure is available to anyone wishing to run an arbitrary \*service*\, containerized application environments, virtualized client operation systems or running complex computing infrastructure. The service runs on OpenStack (version Rocky).
Cloud infrastructure provides an environment for running your own virtual servers or whole virtual environments as a service. This infrastructure is available to anyone wishing to run *arbitrary* services, containerized application environments, unusual operating systems or complex computing infrastructures.
## Credits
The service is owned and operated by a joint venture of the Institute of Computer Science of Masaryk University and Cesnet, the national e-infrastructure operator.
The service is owned and operated as a joint venture of CESNET, the national e-infrastructure for science, development and education in Czech Republic and Institute of Computer Science of Masaryk University.
![](/logos.png)
![](/logos-cesnet.png)
![](/logos-muni.png)
## How to use this guide
This guide aims to provide a basic walk-through for setting up your virtual environment. Several topics are covered. If you are a complete beginner we recommend starting in the [Quickstart](0-quickstart/README.md) section which will walk you through all the necessary activities step by step. Use the left sidebar for navigation throughout the documentation. You can also download individual pages to PDF for printing or later use.
This guide aims to provide basic walkthrough to how to set up your virtual environment. Several topics are covered. If you are a complete beginner we recommend starting with the Quickstart which will walk you through all the necessary activities step by step. Use the left sidebar for navigation throughout the documentation. You can also download individual pages to PDF for print or later use.
Bear in mind that this is not the complete documentation to OpenStack but rather a quick guide that is supposed to help you with elementary setup. If you need more information, please turn to the official OpenStack [documentation](https://docs.openstack.org/rocky/).
Bear in mind that this is not the complete documentation to OpenStack but rather a quick guide that is supposed to help you with elementary use of our infrastructure. If you need more information, please turn to the official [OpenStack Documentation](https://docs.openstack.org/rocky/user/).
## Terms and Conditions
The service is accessible to all users of the CESNET e-infrastructure for science, development and education. The service includes creation of virtual servers on the OpenStack platform. The service does NOT include installation and management of an operating system or server applications. You may contact the service desk which may help you find a qualified administrator for your endeavor.
The service is provided for free to Masaryk University employees and workgroups. The service includes creation of a virtual server on the OpenStack platform. The service does NOT include installation and management of an operation system or server applications. You may contact the service desk which will help you find a qualified administrator for your endeavour, if your skills are limited.
The membership in MetaCentrum is allowed without any restrictions only to persons from academic environment of the Czech republic with research objectives. In a case of interest from commercial company (i.e. its research part), it is necessary to consult your interest and its possible fulfillment. As the MetaCentrum user you are allowed to use currently available computational resources for your research aims and projects. As a MetaCentrum employee your membership brings you access to resources, information and materials necessary for your work.
By submitting an application you also accept the following rules which had to be checked in MetaCentrum end user statement before application submission. Using MetaVO is free of charge but these rules are obligatory and they should be observed as their violation can lead to termination of your MetaCentrum membership.
[MetaCentrum end user statement](https://www.metacentrum.cz/en/about/rules/index.html)
[NGI MetaCentrum Usage Rules](https://www.metacentrum.cz/en/about/rules/index.html)
[Appreciation formula / Acknowlegement in publications](https://wiki.metacentrum.cz/wiki/Usage_rules/Acknowledgement)
[Account validity](https://wiki.metacentrum.cz/wiki/Usage_rules/Account)
[Annual report](https://wiki.metacentrum.cz/wiki/MetaCentrum_Annual_Report_%E2%88%92_Author_Instructions)
[Terms and conditions for the access to the CESNET e-infrastructure](https://www.cesnet.cz/conditions/?lang=en)
The following already established terms and conditions apply:
* [Terms and Conditions for Access to the CESNET e-infrastructure](https://www.cesnet.cz/conditions/?lang=en)
* [MetaCentrum End User Statement and Usage Rules](https://www.metacentrum.cz/en/about/rules/index.html)
* [Appreciation Formula / Acknowlegement in Publications](https://wiki.metacentrum.cz/wiki/Usage_rules/Acknowledgement)
* [Account Validity](https://wiki.metacentrum.cz/wiki/Usage_rules/Account)
* [Annual Report](https://wiki.metacentrum.cz/wiki/MetaCentrum_Annual_Report_%E2%88%92_Author_Instructions)
At the end of each year, the system will ask you to prolong your account. You will be asked to fill out your MetaCentrum usage description, description of achieved results and a list of publications for the last year.
At the end of each year, the system will ask you to extend your account. You will be asked to fill out your usage description, description of achieved results and provide a list of publications for the last year.
{
"title": "MetaCloud User Documentation",
"description": "This book aims to provide basic user manual for MetaCloud users.",
"title": "MetaCentrum Cloud User Documentation",
"description": "This book aims to provide basic user manual for MetaCentrum Cloud users.",
"author": "Cloud Commando @ CESNET/ICS MU",
"language": "en",
"plugins": [
......
ics-logo.png

8.18 KiB

logos-cesnet.png

245 KiB

logos-muni.png

128 KiB

logos.png

572 KiB

uvt-logo.jpeg

3.74 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment