diff --git a/content/_index.md b/content/_index.md index 125680dca260aee5548ea740eb8d5677e079e138..63d5101e421d56f5eff161a42bd204a6031b6226 100644 --- a/content/_index.md +++ b/content/_index.md @@ -8,8 +8,8 @@ draft: false {{< hint danger >}} **WARNING** -<a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/register/#personal-project">User projects</a> (generated for every user) are not meant to contain production machines. -If you use your personal project for long-term services, you have to to ask for a <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/register/#group-project">GROUP</a> project (even if you do not work in a group or you do not need any extra quotas). +[User projects](/cloud/register/#personal-project) (generated for every user) are not meant to contain production machines. +If you use your personal project for long-term services, you have to to ask for a [GROUP](/cloud/register/#group-project) project (even if you do not work in a group or you do not need any extra quotas). {{</hint>}} @@ -32,16 +32,16 @@ Most important cloud resources are: The left sidebar can be used for navigation throughout the documentation. The whole guide can also be downloaded as PDFs for printing or later use. -__New users__ should head over to the [Get Access](/register/README.md) +__New users__ should head over to the [Get Access](/cloud/register) section and make sure they have an active user account and required permissions to access the service. -__Beginners__ should start in the [Quick Start](/quick-start/README.md) +__Beginners__ should start in the [Quick Start](/cloud/quick-start) section which provides a step-by-step guide for starting the first virtual machine instance. -__Advanced users__ should continue in the [Advanced Features](/gui/README.md) -or [Command Line Interface](/cli/README.md) sections, as these are +__Advanced users__ should continue in the [Advanced Features](/cloud/gui) +or [Command Line Interface](/cloud/cli) sections, as these are more suitable for complex use cases and exploration of available features. @@ -50,7 +50,7 @@ should contact user support and request assistance specifically for their use case. __Frequently asked questions__ and corresponding answers can be found in -the [FAQ](/faq/README.md) section. Please, consult this section before +the [FAQ](/cloud/faq) section. Please, consult this section before contacting user support. Bear in mind that this is not the complete documentation to OpenStack @@ -59,4 +59,4 @@ use of our infrastructure. If you need more information, please turn to [the official documentation](https://docs.openstack.org/train/user/) or contact user support and describe your use case. -Please visit [Network](/network/README.md) section in order to see how you should set up the network. +Please visit [Network](/cloud/network) section in order to see how you should set up the network. diff --git a/content/cloud/advanced-features/index.md b/content/cloud/advanced-features/index.md index e4a5b29fedd442d26650cfe19addff09ecdf433d..e147e074a6b4a1044f7c654b6076397b7db0577e 100644 --- a/content/cloud/advanced-features/index.md +++ b/content/cloud/advanced-features/index.md @@ -6,7 +6,7 @@ draft: false The following guide will introduce you to advanced features available in MetaCentrum Cloud. -For basic instructions on how to start a virtual machine instance, see [Quick Start](/quick-start/README.md). +For basic instructions on how to start a virtual machine instance, see [Quick Start](/cloud/quick-start). ## Orchestration @@ -27,7 +27,7 @@ Instructions for uploading custom image: 1. Upload only images in RAW format (not qcow2, vmdk, etc.). -2. Upload is supported only through OpenStack [CLI](https://cloud.gitlab-pages.ics.muni.cz/documentation/cli/) with Application Credentials. +2. Upload is supported only through OpenStack [CLI](/cloud/cli/) with Application Credentials. 3. Each image needs to contain metadata: ``` @@ -74,10 +74,11 @@ In OpenStack there are 4 possible visibilities of particular image: **public, p This is especially beneficial in case of great number of users who should get access to this image or if you own image that is old but some users might still require that image. In that case you can make set old image and **Community image** and set new one as default. - <div style="border-width:0;border-left:5px solid #b8d6f4;background-color:rgba(255,0,0,0.3);margin:20px 0;padding:10px 20px;font-size:15px;"> - <strong>WARNING:</strong><br/><br/> - To create or upload this image you must have an <b>image_uploader</b> right. - </div> +{{< hint danger >}} +**WARNING** + +To create or upload this image you must have an <b>image_uploader</b> right. +{{</hint>}} Creating a new **Community image** can look like this: @@ -281,7 +282,7 @@ In both cases you will need application credentials to be able to manage your da ### Swift credentials -The easiest way to generate **Swift** storage credentials is through [MetaCentrum cloud dashboard](https://dashboard.cloud.muni.cz). You can generate application credentials as described [here](/cli/#getting-credentials). You must have role **heat_stack_owner**. +The easiest way to generate **Swift** storage credentials is through [MetaCentrum cloud dashboard](https://dashboard.cloud.muni.cz). You can generate application credentials as described [here](/cloud/cli/#getting-credentials). You must have role **heat_stack_owner**. ### S3 credentials diff --git a/content/cloud/best-practices/index.md b/content/cloud/best-practices/index.md index aca2370115b1456c8762e56bbccd06d504855d3e..25ac142141e65da8a62eadf0f9b589a91919892c 100644 --- a/content/cloud/best-practices/index.md +++ b/content/cloud/best-practices/index.md @@ -7,12 +7,12 @@ draft: false Following article summarizes effective approaches how to use our cloud. ## How many public IP addresses I need? -There are [two pools of public IPv4 addresses available](/network/#group-project). -**Unfortunately the amount of available public IPv4 addresses is limited.** Read the details on [how to set-up your project networking](/network/). +There are [two pools of public IPv4 addresses available](/cloud/network/#group-project). +**Unfortunately the amount of available public IPv4 addresses is limited.** Read the details on [how to set-up your project networking](/cloud/network/). In most cases even when you build huge cloud infrastructure you should be able to access it via few (up-to two) public IP addresses. - + There are following project VMs in the cloud architecture: @@ -105,7 +105,7 @@ There are several options how to transfer project to cloud resources: * automatically with `terraform` * indirectly in a project container (example: [releasing a project container image](https://gitlab.ics.muni.cz/cloud/cloud-estimate-pi/-/blob/de673766b832c48142c6ad1be73f5bce046b02a2/.gitlab-ci.yml#L17-80), [pulling and running a project image](https://gitlab.ics.muni.cz/cloud/cloud-estimate-pi/-/blob/de673766b832c48142c6ad1be73f5bce046b02a2/ansible/roles/cloud-project-container/tasks/deploy.yml#L16-28)) * indirectly in OpenStack (glance) image (you need to obtain image-uploader role) - * OpenStack Glance images may be [public, private, community or shared](/gui/#image-visibility). + * OpenStack Glance images may be [public, private, community or shared](/cloud/gui/#image-visibility). ### ssh to cloud VM resources and manual update diff --git a/content/cloud/cli/index.md b/content/cloud/cli/index.md index 435f2de82437f91ef03f8db38c2c4eb936892368..d32a577ba244e0eaea73661ebb5310803a1873a7 100644 --- a/content/cloud/cli/index.md +++ b/content/cloud/cli/index.md @@ -192,10 +192,11 @@ $ openstack router set --external-gateway public-cesnet-78-128-251 0bd0374d-b62 ## Create volume -<div style="border-width:0;border-left:5px solid #b8d6f4;background-color:rgba(228,240,251,0.3);margin:20px 0;padding:10px 20px;font-size:15px;"> - <strong>WARNING:</strong><br/> - Skipping this section can lead to unreversible loss of data - </div> +{{< hint danger >}} +**WARNING** + +Skipping this section can lead to unreversible loss of data +{{</hint>}} Volumes are create automatically when creating an instance in GUI, but we need to create them manually in case of CLI @@ -274,7 +275,7 @@ $ openstack floating ip delete 147.251.124.248 ## Cloud tools -You can inspect cloud tools [here](/tools) +You can inspect cloud tools [here](/cloud/tools) ## Full Reference See [OpenStack CLI Documentation](https://docs.openstack.org/python-openstackclient/train/). \ No newline at end of file diff --git a/content/cloud/faq/index.md b/content/cloud/faq/index.md index 26a0d7b5ae257f77b7fec6235e13c6286b7dd80b..985e8f0691a4107b2c0b2926f149057281ebe771 100644 --- a/content/cloud/faq/index.md +++ b/content/cloud/faq/index.md @@ -6,7 +6,7 @@ draft: false ## Where I can find how to use MetaCentrum Cloud effectively? -Read our [cloud best-practice tips](/register/README.md). +Read our [cloud best-practice tips](/cloud/register). ## What to expect from the cloud and cloud computing @@ -23,10 +23,10 @@ The most visible [cloud computing](https://en.wikipedia.org/wiki/Cloud_computing * encouraged cloud project agility ## How do I register? -Follow instructions for registering in [MetaCentrum Cloud](/register/README.md). +Follow instructions for registering in [MetaCentrum Cloud](/cloud/register). ## How do I migrate from legacy platforms? -Follow instructions for [migrating from CESNET-MetaCloud or OStack ICS MUNI](/migrate/README.md). +Follow instructions for [migrating from CESNET-MetaCloud or OStack ICS MUNI](/cloud/migrate). ## Where do I report a problem? First, try searching the documentation for an answer to your problem. If that does not yield results, open a @@ -40,7 +40,7 @@ Personal projects can allocate floating IPs from *public-muni-147-251-124* and * Group projects can currently allocate floating IPs from *public-cesnet-78-128-251* and *private-muni-10-16-116*. IP addresses from *public-muni-147-251-124* allocated by users to group projects are released daily, so we encourage using only *public-cesnet-78-128-251* and *private-muni-10-16-116* for group projects. -Follow instructions at [changing the external network](/network/README.md) in order to change your public network. +Follow instructions at [changing the external network](/cloud/network) in order to change your public network. ## Issues with network stability in Docker OpenStack instances use 1442 bytes MTU (maximum transmission unit) instead of standard 1500 bytes MTU. Instance itself is @@ -66,7 +66,7 @@ To access internet from an instance, or access instance from the internet, you c 2. Associate floating IP with this instance. 3. Install [sshuttle](https://github.com/sshuttle/sshuttle) on your client. 4. `sshuttle -r root@jump_host_fip 192.168.0.1/24`. All your traffic to internal OpenStack network *192.168.0.1/24* is now tunneled through jump host. - * **I need to serve content (e.g. webservice) to other users** - public and private clouds provide LBaaS (Load-Balancer-as-a-Service) service, which proxies users traffic to instances. MetaCentrum Cloud provides this service in experimental mode - [documentation](/gui/README.md/#lbaas) + * **I need to serve content (e.g. webservice) to other users** - public and private clouds provide LBaaS (Load-Balancer-as-a-Service) service, which proxies users traffic to instances. MetaCentrum Cloud provides this service in experimental mode - [documentation](/cloud/gui#lbaas) In case, that these options are not suitable for you usecase, you can still request multiple floating IPs. diff --git a/content/cloud/network/index.md b/content/cloud/network/index.md index 2a0c296ec481b13d80e7151f094cba88b79584a0..bf7437c8347050c8fc289345ba8e853816ef13b3 100644 --- a/content/cloud/network/index.md +++ b/content/cloud/network/index.md @@ -15,8 +15,8 @@ For the networking in Cloud2 metacentrum we need to distinguish following scenar **WARNING:** Please read the following rules: - 1. If you are using a <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/register/#personal-project">PERSONAL</a> project you have to use the `78-128-250-pers-proj-net` network to make your instance accesible from external network (e.g. Internet). Use `public-cesnet-78-128-250-PERSONAL` for FIP allocation, FIPs from this pool will be periodically released. - 2. If you are using a <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/register/#group-project">GROUP</a> project you may choose from the `public-cesnet-78-128-251-GROUP`, `public-muni-147-251-124-GROUP` or any other <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/register/#group-project">GROUP</a> network for FIP allocation to make your instance accesible from external network (e.g. Internet). + 1. If you are using a [PERSONAL](/cloud/register/#personal-project) project you have to use the `78-128-250-pers-proj-net` network to make your instance accesible from external network (e.g. Internet). Use `public-cesnet-78-128-250-PERSONAL` for FIP allocation, FIPs from this pool will be periodically released. + 2. If you are using a [GROUP](/cloud/register/#group-project) project you may choose from the `public-cesnet-78-128-251-GROUP`, `public-muni-147-251-124-GROUP` or any other [GROUP](/cloud/register/#group-project) network for FIP allocation to make your instance accesible from external network (e.g. Internet). 3. Violation of the network usage may lead into resource removal and reducing of the quotas assigned. {{< /hint >}} @@ -35,7 +35,7 @@ In group project situation is rather different. You cannot use the same approach **NOTICE** If you use MUNI account, you can use private-muni-10-16-116 and log into the network via MUNI VPN or you can set up Proxy networking, which is described -<a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/network/#proxy-networking">here</a> +[here](/cloud/network/#proxy-networking) {{< /hint >}} #### Virtual Networks @@ -68,19 +68,19 @@ Inside the interactive dialog: {{< hint danger >}} **NOTICE** -If you want to use CLI to create network, please go [here](https://cloud.gitlab-pages.ics.muni.cz/documentation/cli/#create-network) +If you want to use CLI to create network, please go [here](/cloud/cli/#create-network) {{< /hint >}} #### Proxy networking In your OpenStack instances you can you private or public networks. If you use private network and you need to access to the internet for updates etc., -you can visit following [link](/faq/#issues-with-proxy-in-private-networks), where it is explained, how to set up Proxy connection. +you can visit following [link](/cloud/faq/#issues-with-proxy-in-private-networks), where it is explained, how to set up Proxy connection. #### Setup Router gateway (Required for Group projects) -Completing [Create Virtual Machine Instance](/quick-start/#create-virtual-machine-instance) created instance connected +Completing [Create Virtual Machine Instance](/cloud/quick-start/#create-virtual-machine-instance) created instance connected to software defined network represented by internal network, subnet and router. Router has by default gateway address -from External Network chosen by cloud administrators. You can change it to any External Network with [GROUP](/register/#group-project) suffix, that +from External Network chosen by cloud administrators. You can change it to any External Network with [GROUP](/cloud/register/#group-project) suffix, that is visible to you (e.g. **public-muni-147-251-124-GROUP** or **public-cesnet-78-128-251-GROUP**). Usage of External Networks with suffix PERSONAL (e.g. **public-cesnet-78-128-250-PERSONAL**) is discouraged. IP addresses from PERSONAL segments will be automatically released from Group projects. @@ -90,7 +90,7 @@ For changing gateway IP address follow these steps: If router exists with another settings, then use button Clear Gateway, confirm Clear Gateway. If router isn't set then use button Create router and choose network. -2. From list of External Network choose **public-cesnet-78-128-251-GROUP**, **public-muni-147-251-124-GROUP** or any other [GROUP](/register/#group-project) network you see. +2. From list of External Network choose **public-cesnet-78-128-251-GROUP**, **public-muni-147-251-124-GROUP** or any other [GROUP](/cloud/register/#group-project) network you see.  @@ -114,7 +114,7 @@ Now you need to attach your internal network to the router. {{< hint info >}} **NOTICE** -If you want to use CLI to manage routers, please go [here](https://cloud.gitlab-pages.ics.muni.cz/documentation/cli/#router-management) +If you want to use CLI to manage routers, please go [here](/cloud/cli/#router-management) {{< /hint >}} @@ -131,7 +131,7 @@ Routers can also be used to route traffic between internal networks. This is an {{< hint danger >}} **WARNING** -There is a limited number of Floating IP adresses. So please before you ask for more Floating IP address, visit and read <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/faq/#how-many-floating-ips-does-my-group-project-need">https://cloud.gitlab-pages.ics.muni.cz/documentation/faq/#how-many-floating-ips-does-my-group-project-need</a>. +There is a limited number of Floating IP adresses. So please before you ask for more Floating IP address, visit and read [FAQ](/cloud/faq/#how-many-floating-ips-does-my-group-project-need) {{< /hint >}} @@ -172,7 +172,7 @@ and the IP in question will remain allocated to you and consume your Floating IP {{< hint info >}} **NOTICE** -If you want to use CLI to manage FIP, please go <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/cli/#floating-ip-address-management">here</a>. +If you want to use CLI to manage FIP, please go [here](/cloud/cli/#floating-ip-address-management). {{< /hint >}} diff --git a/content/cloud/news/index.md b/content/cloud/news/index.md index 1f16cfb3791a83caf6c113f9739bf451d8255474..78911e59e24d2080fc7bffd19e8e2b25e3176ec2 100644 --- a/content/cloud/news/index.md +++ b/content/cloud/news/index.md @@ -22,7 +22,7 @@ draft: false * hpc.ics-gladosag-full * csirtmu.tiny1x2 -None of the parameters were decreased but increased. Updated parameters were Net througput, IOPS and Disk througput. Existing instances will have the previous parameters so if you want to get new parameters, **make a data backup** and rebuild your instance You can check list of flavors [here](/flavors/README.md). +None of the parameters were decreased but increased. Updated parameters were Net througput, IOPS and Disk througput. Existing instances will have the previous parameters so if you want to get new parameters, **make a data backup** and rebuild your instance You can check list of flavors [here](/cloud/flavors). **2021-04-13** OpenStack image `centos-8-1-1911-x86_64_gpu` deprecation in favor of `centos-8-x86_64_gpu`. Deprecated image will be still available for existing VM instances, but will be moved from public to community images in about 2 months. diff --git a/content/cloud/putty/index.md b/content/cloud/putty/index.md index 96b175b6257143f5c2b45ba4a7cf7f1cf5d4a15a..77123a1e262f165b79dbcf2b980277c5ccc18df7 100644 --- a/content/cloud/putty/index.md +++ b/content/cloud/putty/index.md @@ -15,7 +15,7 @@ We recommend to download [Windows Installer](https://www.chiark.greenend.org.uk/ ## PuTTY - Connect to the Instance -* Run PuTTY and enter Host name in format "login@Floating IP address" where [login](/quick-start#create-virtual-machine-instance) is for example debian for Debian OS and Floating IP is [IP address](/quick-start/#associate-floating-ip) to access instance from internet. +* Run PuTTY and enter Host name in format "login@Floating IP address" where [login](/cloud/quick-start#create-virtual-machine-instance) is for example debian for Debian OS and Floating IP is [IP address](/cloud/quick-start/#associate-floating-ip) to access instance from internet. * In Category -> Connection -> SSH -> Auth: * Select **Attempt authentication using Pageant** * Select **Allow agent forwarding** diff --git a/content/cloud/quick-start/index.md b/content/cloud/quick-start/index.md index a649fe5105961bdb4619afe6302b639eeb81e261..77a1423d77fbdbad8c19ae3ea1c393e2f01e958f 100644 --- a/content/cloud/quick-start/index.md +++ b/content/cloud/quick-start/index.md @@ -158,15 +158,15 @@ For details, refer to [the official documentation](https://docs.openstack.org/ho * Use button **Create Key Pair** * Continue steps in section [Create Key Pair](#create-key-pair) -> Create Key Pair * Add key and continue using button **Next** -  +  7. __(optional)__ On the Configuration tab, you can use `user_data` to customize your instance at boot. -  +  See [cloud-init](https://cloud-init.io/) for details. 8. Use button Launch Instance to initialize new instance -9. Wait until instance initialization finishes and [Associate Floating IP](/network/#associate-floating-ip). For group project always select the same network as used in [Router gateway](/network/#setup-router-gateway-required-for-group-projects) +9. Wait until instance initialization finishes and [Associate Floating IP](/cloud/network/#associate-floating-ip). For group project always select the same network as used in [Router gateway](/network/#setup-router-gateway-required-for-group-projects)  10. Login using your SSH key as selected in Key pair above @@ -175,7 +175,7 @@ Connect to the instance using **ssh image login**, [id_rsa key registered in Ope {{< hint info >}} **NOTICE** -On Linux and Mac you can use already present SSH client. On Windows there are other possibilities how to connect via SSH. One of the most common is <a href="https://en.wikipedia.org/wiki/PuTTY">PuTTy</a> SSH client. How to configure and use PuTTy you can visit our tutorial <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/putty/#putty">here</a>. +On Linux and Mac you can use already present SSH client. On Windows there are other possibilities how to connect via SSH. One of the most common is [PuTTy](https://en.wikipedia.org/wiki/PuTTY) SSH client. How to configure and use PuTTy you can visit our tutorial [here](/cloud/putty/#putty). {{</hint>}} @@ -216,8 +216,8 @@ For details, refer to [the official documentation](https://docs.openstack.org/ho {{< hint danger >}} **WARNING** -If you have <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/register/#group-project">GROUP</a> project, you need to configure -Router gateway for your network. <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/network/#setup-router-gateway-required-for-group-projects">Here</a> you can find the manual. +If you have [GROUP](/cloud/register/#group-project) project, you need to configure +Router gateway for your network. [Here](/cloud/network/#setup-router-gateway-required-for-group-projects) you can find the manual. {{</hint>}} @@ -227,7 +227,7 @@ Router gateway for your network. <a href="https://cloud.gitlab-pages.ics.muni.cz {{< hint danger >}} **WARNING** To make an instance accessible from external networks (e.g., The Internet), a so-called Floating IP Address has to be -associated with it. <a href="https://cloud.gitlab-pages.ics.muni.cz/documentation/network/#associate-floating-ip">Here</a> you can find the manual. +associated with it. [Here](/cloud/network/#associate-floating-ip) you can find the manual. {{</hint>}} ## Create Volume diff --git a/content/cloud/register/index.md b/content/cloud/register/index.md index 837b641bb2b9b35b4415505653e9e02365f478b9..ff9dfd2f74c335809925c00b818e9e83b84fbf53 100644 --- a/content/cloud/register/index.md +++ b/content/cloud/register/index.md @@ -64,7 +64,7 @@ request a group project from User Support and provide the following basic inform * __name of the project__, * __purpose of the project__, * __contact information__, -* __amount and type of requested resources__ _[(please read first)](/faq/#how-many-floating-ips-does-my-group-project-need)_, +* __amount and type of requested resources__ _[(please read first)](/cloud/faq/#how-many-floating-ips-does-my-group-project-need)_, * __impact would the service have on unavailability for 1h, 1d, 1w__, * __estimated length of the project__, * __access control information__ _[(info)](#get-access-control-information)_. diff --git a/content/cloud/tools/index.md b/content/cloud/tools/index.md index 24a5fe06559417f50a23b43ebf6bb234cd68631a..2cfe2e41ed82c154850baeeef3345ff719c2f9ea 100644 --- a/content/cloud/tools/index.md +++ b/content/cloud/tools/index.md @@ -4,4 +4,4 @@ date: 2021-05-18T11:22:35+02:00 draft: false --- -On this address [https://gitlab.ics.muni.cz/cloud/cloud-tools](https://gitlab.ics.muni.cz/cloud/cloud-tools) you can find a docker container with all modules required for cloud management, if you are interested in managing your cloud platform via CLI. If so, you can check our guide how to use CLI cloud interface [here](https://cloud.gitlab-pages.ics.muni.cz/documentation/cli/). \ No newline at end of file +On this address [https://gitlab.ics.muni.cz/cloud/cloud-tools](https://gitlab.ics.muni.cz/cloud/cloud-tools) you can find a docker container with all modules required for cloud management, if you are interested in managing your cloud platform via CLI. If so, you can check our guide how to use CLI cloud interface [here](/cloud/cli/). \ No newline at end of file