From 0dcdf1e9610dc0adf1849329b841f33625d0768c Mon Sep 17 00:00:00 2001 From: berkas1 <berka@berkasimon.com> Date: Tue, 21 Sep 2021 11:34:59 +0200 Subject: [PATCH] fix(content): fix internal links for new documentation address --- content/_index.md | 6 +++--- content/cloud/advanced-features/index.md | 6 +++--- content/cloud/best-practices/index.md | 8 ++++---- content/cloud/cli/index.md | 2 +- content/cloud/faq/index.md | 10 +++++----- content/cloud/network/index.md | 22 +++++++++++----------- content/cloud/news/index.md | 2 +- content/cloud/putty/index.md | 2 +- content/cloud/quick-start/index.md | 14 +++++++------- content/cloud/register/index.md | 4 ++-- content/cloud/tools/index.md | 2 +- layouts/partials/menu.html | 8 ++++---- 12 files changed, 43 insertions(+), 43 deletions(-) diff --git a/content/_index.md b/content/_index.md index c00125b..a7fd1b2 100644 --- a/content/_index.md +++ b/content/_index.md @@ -15,9 +15,9 @@ If you use your personal project for long-term services, you have to ask for a [ {{<hint info>}} **Quick navigation:** -- [I want to request a group project.](/documentation/cloud/register/#group-project) -- [I want to request quota increase or additional flavor for existing project.](/documentation/cloud/register/#increase-quotas-for-existing-group-project) -- [I have a group project already and need to get machines up and running.](/documentation/cloud/quick-start/) +- [I want to request a group project.](/cloud/register/#group-project) +- [I want to request quota increase or additional flavor for existing project.](/cloud/register/#increase-quotas-for-existing-group-project) +- [I have a group project already and need to get machines up and running.](/cloud/quick-start/) - [I need technical support or security contact.](https://cloud.muni.cz/contacts/) {{</hint>}} diff --git a/content/cloud/advanced-features/index.md b/content/cloud/advanced-features/index.md index 8ff51b9..0c90f85 100644 --- a/content/cloud/advanced-features/index.md +++ b/content/cloud/advanced-features/index.md @@ -7,7 +7,7 @@ toc: true 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](/documentation/cloud/quick-start). +For basic instructions on how to start a virtual machine instance, see [Quick Start](/cloud/quick-start). ## Orchestration @@ -28,7 +28,7 @@ Instructions for uploading a custom image: 1. Upload only images in RAW format (not qcow2, vmdk, etc.). -2. Upload is supported only through OpenStack [CLI](/documentation/cloud/cli/) with Application Credentials. +2. Upload is supported only through OpenStack [CLI](/cloud/cli/) with Application Credentials. 3. Each image needs to contain metadata: ``` @@ -314,7 +314,7 @@ In both cases, you will need application credentials to be able to manage your d ### 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](/documentation/cloud/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 abb503e..e90356d 100644 --- a/content/cloud/best-practices/index.md +++ b/content/cloud/best-practices/index.md @@ -8,12 +8,12 @@ weight: -90 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](/documentation/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](/documentation/cloud/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 the following project VMs in the cloud architecture: @@ -106,7 +106,7 @@ There are several options how to transfer the 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](/documentation//cloud/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 fcceda2..bf87034 100644 --- a/content/cloud/cli/index.md +++ b/content/cloud/cli/index.md @@ -275,7 +275,7 @@ $ openstack floating ip delete 147.251.124.248 ## Cloud tools -You can inspect cloud tools [here](/documentation/cloud/tools) +You can inspect cloud tools [here](/cloud/tools) ## Full Reference See [OpenStack CLI Documentation](https://docs.openstack.org/python-openstackclient/train/). diff --git a/content/cloud/faq/index.md b/content/cloud/faq/index.md index ed55902..b98ca5c 100644 --- a/content/cloud/faq/index.md +++ b/content/cloud/faq/index.md @@ -7,7 +7,7 @@ weight: 90 ## Where I can find how to use MetaCentrum Cloud effectively? -Read our [cloud best-practice tips](/documentation/cloud/register). +Read our [cloud best-practice tips](/cloud/register). ## What to expect from the cloud and cloud computing @@ -24,10 +24,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](/documentation/cloud/register). +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](/documentation/cloud/migrate). +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 @@ -41,7 +41,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](/documentation/cloud/network) 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. The instance itself can set up correct MTU with its counterpart via Path MTU Discovery. Docker needs MTU set up explicitly. Refer documentation for setting up @@ -66,7 +66,7 @@ To access the internet from an instance, or access an instance from the internet 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 the internal OpenStack network *192.168.0.1/24* is now tunneled through the jump host. - * **I need to serve content (e.g. web service) 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](/documentation/cloud/gui#lbaas) + * **I need to serve content (e.g. web service) 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 your use case, you can still request multiple floating IPs. diff --git a/content/cloud/network/index.md b/content/cloud/network/index.md index 97d6286..9d3dd70 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 the following s **WARNING:** Please read the following rules: - 1. If you are using a [PERSONAL](/documentation/cloud/register/#personal-project) project you have to use the `78-128-250-pers-proj-net` network to make your instance accessible from an 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](/documentation/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](/documentation/cloud/register/#group-project) network for FIP allocation to make your instance accessible 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 accessible from an 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 accessible from external network (e.g. Internet). 3. Violation of network usage may lead to resource removal and reduction of the quotas assigned. {{< /hint >}} @@ -35,7 +35,7 @@ In a group, the project situation is rather different. You cannot use the same a **NOTICE** If you use a 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 -[here](/documentation/cloud/network/#proxy-networking) +[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](/documentation/cloud/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 a private network and you need to access the internet for updates etc., -you can visit following [link](/documentation/cloud/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](/documentation/cloud/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 a software-defined network represented by the internal network, subnet, and router. The router has by default a gateway address -from External Network chosen by cloud administrators. You can change it to any External Network with [GROUP](/documentation/cloud/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 the router exists with other settings, then use the button Clear Gateway and then confirm Clear Gateway. If the router isn't set then use the button Create router and choose the network. -2. From list of External Network choose **public-cesnet-78-128-251-GROUP**, **public-muni-147-251-124-GROUP** or any other [GROUP](/documentation/cloud/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](/documentation/cloud/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 addresses. So please before you ask for more Floating IP address, visit and read [FAQ](/documentation/cloud/faq/#how-many-floating-ips-does-my-group-project-need) +There is a limited number of Floating IP addresses. 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 >}} @@ -171,7 +171,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 [here](/documentation/cloud/cli/#floating-ip-address-management). +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 3aad81d..009d669 100644 --- a/content/cloud/news/index.md +++ b/content/cloud/news/index.md @@ -26,7 +26,7 @@ GeekdocHidden: true * hpc.ics-gladosag-full * csirtmu.tiny1x2 -None of the parameters were decreased but increased. Updated parameters were net throughput, IOPS, and disk throughput. 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 checklist of flavors [here](/documentation/cloud/flavors). +None of the parameters were decreased but increased. Updated parameters were net throughput, IOPS, and disk throughput. 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 checklist 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`. The 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 cca5ce7..a3a1539 100644 --- a/content/cloud/putty/index.md +++ b/content/cloud/putty/index.md @@ -15,7 +15,7 @@ We recommend downloading [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](/documentation/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. +* 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 aa5a782..15a79e2 100644 --- a/content/cloud/quick-start/index.md +++ b/content/cloud/quick-start/index.md @@ -148,7 +148,7 @@ For details, refer to [the official documentation](https://docs.openstack.org/ho * For personal project select personal-project-network-subnet from network 78-128-250-pers-proj-net  - * For group project select group-project-network-subnet from network group-project-network (check if [Router gateway](/documentation//network#associate-floating-ip") is set) + * For group project select group-project-network-subnet from network group-project-network (check if [Router gateway](//network#associate-floating-ip") is set)  6. Key pair * **If public key was imported already**, add existing key to the instance and continue using button **Next** @@ -162,21 +162,21 @@ For details, refer to [the official documentation](https://docs.openstack.org/ho  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 the button Launch Instance to initialize a new instance -9. Wait until instance initialization finishes and [Associate Floating IP](/documentation/cloud/network/#associate-floating-ip). For group project always select the same network as used in [Router gateway](cloud/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](cloud/network/#setup-router-gateway-required-for-group-projects)  10. Login using your SSH key as selected in Key pair above -Connect to the instance using **ssh image login**, [id_rsa key registered in Openstack](#create-key-pair) and [Floating IP](/documentation/network/#associate-floating-ip). +Connect to the instance using **ssh image login**, [id_rsa key registered in Openstack](#create-key-pair) and [Floating IP](/network/#associate-floating-ip). {{< hint info >}} **NOTICE** -On Linux and Mac, you can use the already present SSH client. On Windows, there are other possibilities for 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](/documentation/cloud/putty/#putty). +On Linux and Mac, you can use the already present SSH client. On Windows, there are other possibilities for 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>}} @@ -217,7 +217,7 @@ For details, refer to [the official documentation](https://docs.openstack.org/ho {{< hint danger >}} **WARNING** -If you have [GROUP](/documentation/cloud/register/#group-project) project, you need to configure +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>}} @@ -228,7 +228,7 @@ Router gateway for your network. [Here](cloud/network/#setup-router-gateway-requ {{< 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. [Here](/documentation/cloud/network/#associate-floating-ip) 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 e67d73e..9d9e6f0 100644 --- a/content/cloud/register/index.md +++ b/content/cloud/register/index.md @@ -68,14 +68,14 @@ request a group project using [this form](https://projects.cloud.muni.cz/) and p * __name of the project__, * __purpose of the project__, * __contact information__, -* __amount and type of requested resources__ _[(please read first)](/documentation/cloud/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)_. ## Increase quotas for existing group project -To request quota increase or access to particular [flavor](/documentation/cloud/flavors), please use [this form](https://projects.cloud.muni.cz/). +To request quota increase or access to particular [flavor](/cloud/flavors), please use [this form](https://projects.cloud.muni.cz/). ## Get access control information diff --git a/content/cloud/tools/index.md b/content/cloud/tools/index.md index 14cce48..7de15d3 100644 --- a/content/cloud/tools/index.md +++ b/content/cloud/tools/index.md @@ -6,4 +6,4 @@ weight: 100 disableToc: true --- -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 on how to use the CLI cloud interface [here](/documentation/cloud/cli/). +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 on how to use the CLI cloud interface [here](/cloud/cli/). diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html index 6196be7..9a7b484 100644 --- a/layouts/partials/menu.html +++ b/layouts/partials/menu.html @@ -7,10 +7,10 @@ <ul class="gdoc-nav__list"> <li><span class="flex"><strong>Basics</strong></span> <ul class="gdoc-nav__list"> - <li><span class="flex"><a class="gdoc-nav__entry " href="/documentation/cloud/news/">News</a></span></li> - <li><span class="flex"><a class="gdoc-nav__entry " href="/documentation/cloud/about/">About Metacentrum cloud</a></span></li> - <li><span class="flex"><a class="gdoc-nav__entry " href="/documentation/cloud/flavors">Flavors</a></span></li> - <li><span class="flex"><a class="gdoc-nav__entry " href="/documentation/cloud/project-expiration/">Project Expiration Policy</a></span></li> + <li><span class="flex"><a class="gdoc-nav__entry " href="/cloud/news/">News</a></span></li> + <li><span class="flex"><a class="gdoc-nav__entry " href="/cloud/about/">About Metacentrum cloud</a></span></li> + <li><span class="flex"><a class="gdoc-nav__entry " href="/cloud/flavors">Flavors</a></span></li> + <li><span class="flex"><a class="gdoc-nav__entry " href="/cloud/project-expiration/">Project Expiration Policy</a></span></li> </ul> </li> </ul> -- GitLab