diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1ca73d027889ffcdca6588425fc89cc9b9e499c9..3cbf3a9ad6a7236d35e5ba3478eea7c58460a8e5 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -12,12 +12,12 @@ pages: - apk add py3-yaml script: - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.ics.muni.cz/cloud/hiera.git - - sed -i '9,$d' content/cloud/flavours/index.md - - echo "{{< csv-table header=\"true\">}}" >> content/cloud/flavours/index.md + - sed -i '9,$d' content/cloud/flavors/index.md + - echo "{{< csv-table header=\"true\">}}" >> content/cloud/flavors/index.md - python3 ci/flavor_info_miner.py --hiera-file ./hiera/group/ostack/flavors.yaml - - cat flavors.csv >> content/cloud/flavours/index.md - - echo "{{</csv-table>}}" >> content/cloud/flavours/index.md - - cat content/cloud/flavours/index.md + - cat flavors.csv >> content/cloud/flavors/index.md + - echo "{{</csv-table>}}" >> content/cloud/flavors/index.md + - cat content/cloud/flavors/index.md - hugo --config config.toml -D --destination=./public artifacts: diff --git a/config.toml b/config.toml index d2eead35f900e95c399aa523c4f521fe0623a82a..7d8bb15ce9a15918112e5b94ef13864a611fb972 100644 --- a/config.toml +++ b/config.toml @@ -1,6 +1,6 @@ baseURL = "https://cloud.gitlab-pages.ics.muni.cz/documentation/" languageCode = "en-us" -title = "cloud.muni.cz documentation" +title = "Metacentrum Cloud Documentation" theme = "hugo-geekdoc" pygmentsUseClasses = true diff --git a/content/cloud/about/_index.md b/content/cloud/about/_index.md index 839babda7caa898ec7d1365bc0d3cbd50de1f623..ad1cac89f7aa1ba51ee5088acae8f005697a528a 100644 --- a/content/cloud/about/_index.md +++ b/content/cloud/about/_index.md @@ -2,6 +2,7 @@ title: "About metacentrum.cz cloud" date: 2021-05-18T11:22:35+02:00 draft: false +weight: -100 --- ## Hardware diff --git a/content/cloud/advanced-features/index.md b/content/cloud/advanced-features/index.md index 8cba8b07c42855d7491b9a038ff3e9beda35508b..32e413cbead192a0ef78ae89c4dacf83ba0a547d 100644 --- a/content/cloud/advanced-features/index.md +++ b/content/cloud/advanced-features/index.md @@ -65,7 +65,7 @@ In OpenStack there are 4 possible visibilities of particular image: **public, p ### 3. Shared image - **Shared image** is an image visible to only to owner and possibly certain groups that owner specified. How to share an image between project, please read following [tutorial](/gui/#image-sharing-between-projects) below. + **Shared image** is an image visible to only to owner and possibly certain groups that owner specified. How to share an image between project, please read following [tutorial](#image-sharing-between-projects) below. ### 4. Community image **Community image** is an image that is accesible to everyone, however it is not visible in dashboard. These images can be listed in CLI via command: diff --git a/content/cloud/best-practices/index.md b/content/cloud/best-practices/index.md index f6c647e5dc9acec75db8fb206ce6ed6bfca4cd84..8e17cbb35b2a65bfddc67711ca39edfdf897a7cc 100644 --- a/content/cloud/best-practices/index.md +++ b/content/cloud/best-practices/index.md @@ -2,6 +2,7 @@ title: "Best practices" date: 2021-05-18T11:22:35+02:00 draft: false +weight: -90 --- Following article summarizes effective approaches how to use our cloud. diff --git a/content/cloud/contribute/index.md b/content/cloud/contribute/index.md index 97425dfa1ae97f0de3b84d452bec535b214f5361..ba550c2354da4b3e7e13a47e5a981310046e7325 100644 --- a/content/cloud/contribute/index.md +++ b/content/cloud/contribute/index.md @@ -2,6 +2,7 @@ title: "Contribute" date: 2021-05-18T11:22:35+02:00 draft: false +weight: 110 --- We use open-source [Hugo](https://gohugo.io/) project to generate the documentation. diff --git a/content/cloud/faq/index.md b/content/cloud/faq/index.md index 0a86bea8c4c3cf88b28f38e8b33491647eb0ade2..df1bb9acc2926fd339dae6702b28d958bae2f4f0 100644 --- a/content/cloud/faq/index.md +++ b/content/cloud/faq/index.md @@ -2,6 +2,7 @@ title: "Frequently Asked Questions" date: 2021-05-18T11:22:35+02:00 draft: false +weight: 90 --- diff --git a/content/cloud/flavours/index.md b/content/cloud/flavors/index.md similarity index 99% rename from content/cloud/flavours/index.md rename to content/cloud/flavors/index.md index e26adfcb234b3a81300cf2bdfcd1b4d01e6ea4e0..90b9e5ee244370757ccba9ccd1e19cd2263ab9c7 100644 --- a/content/cloud/flavours/index.md +++ b/content/cloud/flavors/index.md @@ -1,5 +1,5 @@ --- -title: "Flavours" +title: "Flavors" date: 2021-05-18T11:22:35+02:00 draft: false --- diff --git a/content/cloud/network/index.md b/content/cloud/network/index.md index d33641846dfc81a5e87631626ad6fbd94f76bdf9..761a2b4f1bc98590ceb076e5277227a6c680ac3d 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 [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). + 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 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](/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 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 -[here](cloud/network/#proxy-networking) +[here](/documentation/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](cloud/cli/#create-network) +If you want to use CLI to create network, please go [here](/documentation/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](cloud/faq/#issues-with-proxy-in-private-networks), where it is explained, how to set up Proxy connection. +you can visit following [link](/documentation/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](cloud/quick-start/#create-virtual-machine-instance) created instance connected +Completing [Create Virtual Machine Instance](/documentation/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](/cloud/register/#group-project) suffix, that +from External Network chosen by cloud administrators. You can change it to any External Network with [GROUP](/documentation/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](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](/documentation/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](cloud/cli/#router-management) +If you want to use CLI to manage routers, please go [here](/documentation/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 [FAQ](cloud/faq/#how-many-floating-ips-does-my-group-project-need) +There is a limited number of Floating IP adresses. 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) {{< /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 [here](cloud/cli/#floating-ip-address-management). +If you want to use CLI to manage FIP, please go [here](/documentation/cloud/cli/#floating-ip-address-management). {{< /hint >}} diff --git a/content/cloud/quick-start/index.md b/content/cloud/quick-start/index.md index 0bce9f48f410e6f08a2d941a8867100a6668e2cc..fda1ed53119d5ce96320388fe0aad6612f73daeb 100644 --- a/content/cloud/quick-start/index.md +++ b/content/cloud/quick-start/index.md @@ -2,6 +2,7 @@ title: "Quick Start" date: 2021-05-18T11:22:35+02:00 draft: false +weight: -60 --- diff --git a/content/cloud/register/index.md b/content/cloud/register/index.md index 70dfa83a91e158a34f14414e2d51417571c35ccd..df6125ac9148f7105d933d91f76106754c71e5e6 100644 --- a/content/cloud/register/index.md +++ b/content/cloud/register/index.md @@ -2,6 +2,7 @@ title: "How to Get Access" date: 2021-05-18T11:22:35+02:00 draft: false +weight: -80 --- diff --git a/content/cloud/tools/index.md b/content/cloud/tools/index.md index 2eb35d074ffe38bb1fbb18a1ffc0b165fb05c6f9..818317689aa0fdf74de4a102c09bce8e5349395a 100644 --- a/content/cloud/tools/index.md +++ b/content/cloud/tools/index.md @@ -2,6 +2,7 @@ title: "Cloud Tools" date: 2021-05-18T11:22:35+02:00 draft: false +weight: 100 --- 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](/documentation/cloud/cli/). \ No newline at end of file diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html new file mode 100644 index 0000000000000000000000000000000000000000..a8ca6730f42dc2e1b4edf6f217f92f093f7d8fd3 --- /dev/null +++ b/layouts/partials/menu.html @@ -0,0 +1,24 @@ +<nav> + {{ partial "search" . }} + + <section class="gdoc-nav--more"> + + <h2>Navigation</h2> + <ul class="gdoc-nav__list"> + <li><span class="flex"><strong>Information</strong></span> + <ul><span class="flex"><a class="gdoc-nav__entry " href="https://cloud.gitlab-pages.ics.muni.cz/documentation/cloud/news/">News</a></span></ul> + </li> + </ul> + </section> + + <section class="gdoc-nav--main"> + + {{ if .Site.Params.GeekdocMenuBundle }} + {{ partial "menu-bundle" (dict "current" . "source" .Site.Data.menu.main.main) }} + {{ else }} + {{ partial "menu-filetree" . }} + {{ end }} + </section> + + +</nav>