Skip to content
Merged

Dev #586

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Try to fulfill the following points before the Pull Request is merged:
- [ ] Please create your prs against the dev branch
- [ ] Please WAIT for the tests to finish.
- [ ] All tests have been successfully completed.
- [ ] When adding a new documentation or tutorial, make sure that the markdown is linked in the config.yml

* [ ] Please create your PR against the `dev` branch.
* [ ] Please **wait for all tests to finish**.
* [ ] All tests relevant to the changes introduced by this PR must pass. If a test fails due to an issue unrelated to this PR, it does not block this PR and should be handled separately.
* [ ] When adding new documentation or a tutorial, make sure the corresponding Markdown file is linked in `config.yml`.
* [ ] Once all the above points have been successfully completed, the PR can be merged.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ You can find the documentation
Use the Environment which will also be used in production.

~~~BASH
docker run -it -v "$(pwd):/srv_root/docs" -p "8000:8000" --env ENABLED_HTMLPROOFER=True --entrypoint="mkdocs" quay.io/denbicloud/mkdocswebhook:3.8.0 serve -f /srv_root/docs/config.yml --dev-addr 0.0.0.0:8000
docker run -it -v "$(pwd):/srv_root/docs" -p "8000:8000" --env ENABLED_HTMLPROOFER=True --entrypoint="mkdocs" oci.bi.denbi.de/denbicloud/mkdocswebhook:3.9.7 serve -f /srv_root/docs/config.yml --dev-addr 0.0.0.0:8000
~~~

Or turn off the HTML Proffer for faster startup:

~~~BASH
docker run -it -v "$(pwd):/srv_root/docs" -p "8000:8000" --env ENABLED_HTMLPROOFER=False --entrypoint="mkdocs" quay.io/denbicloud/mkdocswebhook:3.8.0 serve -f /srv_root/docs/config.yml --dev-addr 0.0.0.0:8000
docker run -it -v "$(pwd):/srv_root/docs" -p "8000:8000" --env ENABLED_HTMLPROOFER=False --entrypoint="mkdocs" oci.bi.denbi.de/denbicloud/mkdocswebhook:3.9.7 serve -f /srv_root/docs/config.yml --dev-addr 0.0.0.0:8000
~~~

### Local
Expand Down
26 changes: 22 additions & 4 deletions config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,30 @@ plugins:
raise_error_after_finish: True
retry_max_times: 3
raise_error_excludes:
-1: [ "https://cloud.denbi.de/portal/webapp/#/userinfo", "http://169.254.169.254", "https://signup.aai.lifescience-ri.eu/fed/registrar/?vo=lifescience", "https://login.elixir-czech.org/oidc/", "https://spreg-legacy.aai.elixir-czech.org/spreg/auth/facilities/myServices","http://BIBIGRID_MASTER/ganglia" ]
-1: [ "https://cloud.denbi.de/portal/webapp/#/userinfo", "http://169.254.169.254", "https://signup.aai.lifescience-ri.eu/fed/registrar/?vo=lifescience", "https://login.elixir-czech.org/oidc/", "https://spreg-legacy.aai.elixir-czech.org/spreg/auth/facilities/myServices","http://BIBIGRID_MASTER/ganglia", "https://bastion-prod(dot)denbi(dot)cloud(dot)embl(dot)de" ]
400: [ "http://169.254.169.254" ]
403: [ "https://s3.denbi.uni-tuebingen.de","https://cloud-init.io", "https://linux.die.net/man/5/nfs", "https://geant.org/Services/" ]
403: [ "https://s3.denbi.uni-tuebingen.de","https://www.netapp.com/trident/","https://cloud-init.io", "https://linux.die.net/man/5/nfs", "https://geant.org/Services/", "https://www.netapp.com/trident/ " ]
404: ["https://cloud.denbi.de/about/credits-calculator/"]
429: [ "https://docs.ansible.com" ]
500: [ "https://cloud.denbi.de/register", "https://signup.aai.lifescience-ri.eu/fed/registrar/?vo=elixir_test" ]
504: [ "https://denbi.cloud.embl.de", https://cloud.denbi.de/about/credits-calculator/", "https://packages.ubuntu.com/","https://denbi-cloud.bihealth.org","http://apt-cache.bi.denbi.de:9999","http://129.70.51.2:9999","https://cloud.denbi.dkfz-heidelberg.de","https://denbi-cloud.bioquant.uni-heidelberg.de","https://denbi-cloud.bioquant.uni-heidelberg.de" ]
503: [ "https://s3.denbi.uni-tuebingen.de" ]
504: [ "https://denbi.cloud.embl.de", "https://cloud.denbi.de/about/credits-calculator/", "https://packages.ubuntu.com/","https://denbi-cloud.bihealth.org","http://apt-cache.bi.denbi.de:9999","http://129.70.51.2:9999","https://cloud.denbi.dkfz-heidelberg.de","https://denbi-cloud.bioquant.uni-heidelberg.de","https://denbi-cloud.bioquant.uni-heidelberg.de", "https://docs.kubermatic.com" ]
ignore_urls:
- "https://services.aai.lifescience-ri.eu/spreg/auth/facilities/myServices"
- "https://spreg-legacy.aai.elixir-czech.org/spreg/auth/requests/new"
# Ignore everything in the MathJax assets folder (includes CONTRIBUTING.md)
- ".*assets/mathjax/.*"
- ".*wiki/assets/mathjax/.*"
# URLs blocked by bot protection (e.g. Cloudflare challenge)
- "https://stackoverflow.com/questions/41137494/ha-proxy-rule-404-not-found"
# Ansible docs frequently return 429 (Too Many Requests)
- "https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html"
- "https://docs.ansible.com/ansible/2.9/modules/modules_by_category.html"
- "https://docs.ansible.com/ansible/latest/user_guide/playbooks.html"
- "https://docs.ansible.com/ansible/latest/getting_started/index.html"
ignore_pages:
- assets/mathjax/CONTRIBUTING.md

markdown_extensions:
- abbr
- attr_list
Expand Down Expand Up @@ -153,6 +168,10 @@ nav:
- 'OpenStack Components': Concept/openstack.md
- 'Flavors': Concept/flavors.md
- 'Images': Concept/images.md
- 'Image Builder': Concept/image_builder.md
- 'Network': Concept/network.md
- 'Object Storage Giessen': Concept/object_storage_giessen.md
- 'Volumes': Concept/volumes.md
- 'Tutorials':
- 'Tutorials': Tutorials/index.md
- 'Access de.NBI Virtual Machines from Windows 10': Tutorials/Win10_SSH/index.md
Expand All @@ -173,7 +192,6 @@ nav:
- 'Persistent SSH Sessions': Tutorials/Persistent_SSH_Sessions/index.md
- 'Theia Web IDE': Tutorials/TheiaIde/index.md
- 'UserData': Tutorials/UserData/index.md
- 'Using X2GO': Tutorials/X2GO/x2go.md
- 'FAQ': 'FAQ.md'
- 'Compute Center Specific':
- 'Berlin': Compute_Center/Berlin.md
Expand Down
2 changes: 1 addition & 1 deletion wiki/Concept/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ There are some possibilities to access several VMs through one IP address.

- Jump Host : Use one VM as jump host. That VM has the credentials to ssh into all the other VMs.

- Gateway : Another possibility to use one floating IP for several instances is to setup a gateway. See [UserData tutorial](/Tutorials/UserData) for detailed description how to achieve this.
- Gateway : Another possibility to use one floating IP for several instances is to setup a gateway. See [UserData tutorial](../Tutorials/UserData/index.md) for detailed description how to achieve this.

- VPN : Advanced users can setup a VPN (e.g. using [OpenVPN](https://openvpn.net)) to access cloud instances directly.
2 changes: 1 addition & 1 deletion wiki/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Yes, take a look [here](https://cloud.denbi.de/about/testimonials/)!

### How can I acknowledge the de.NBI Cloud in publications?

See [here](../citation_and_publication/#citation-information) for more information.
See [here](citation_and_publication.md#citation-information) for more information.

### Where can I find the terms of use and privacy policy?

Expand Down
2 changes: 1 addition & 1 deletion wiki/Tutorials/RStudio_Server/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Version from 03.12.2018
This beginner tutorial shows you how to install and run RStudio Server to develop and run your R data analysis on the de.NBI Cloud. This tutorial is meant for beginner users working with the Simple VM for creation of new VM instances.

## 2. Requirements
* Member of a Simple VM project in the de.NBI Cloud. More information how to apply for access can be found here: ([https://www.denbi.de/cloud](https://www.denbi.de/cloud), [Project allocation](/portal/allocation/))
* Member of a Simple VM project in the de.NBI Cloud. More information how to apply for access can be found here: ([https://www.denbi.de/cloud](https://www.denbi.de/cloud), [Project allocation](../../portal/allocation.md))
* An already running instance of a virtual machine (VM) in the de.NBI Cloud running on Ubuntu 18.04
* Access to the de.NBI Cloud via SSH

Expand Down
6 changes: 3 additions & 3 deletions wiki/assets/mathjax/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are lots and lots of ways to get involved, this document covers:
* [feature requests](#feature-requests)
* [change requests](#change-requests)
* [working on MathJax core](#working-on-mathjax-core)
* [key branches and tags](#key-branches--tags)
* [key branches and tags](#key-branches-tags)
* [submitting pull requests](#submitting-pull-requests)
* [testing and quality assurance](#testing-and-quality-assurance)
* [writing documentation](#writing-documentation)
Expand Down Expand Up @@ -69,7 +69,7 @@ Guidelines for bug reports:
case](https://css-tricks.com/reduced-test-cases/). Be specific
about your setup (browser, OS versions, etc). Use services like
[jsbin](http://jsbin.com), [CodePen](http://codepen.io), or
[jsFiddle](http://jsfiddle.com) to make collaboration on minimal
[jsFiddle](https://jsfiddle.net/) to make collaboration on minimal
test cases easier for everyone.

5. **Include a screenshot/cast as a last resort** — Is your
Expand Down Expand Up @@ -237,7 +237,7 @@ requests in the same way as branches.

MathJax's main documentation can be found at [docs.mathjax.org](http://docs.mathjax.org).
The source of the docs is hosted in the
[mathjax/MathJax-docs](http://github.com/mathjax/MathJax-docs) repo here on GitHub.
[mathjax/MathJax-docs](https://github.com/mathjax/MathJax-docs) repo here on GitHub.

The documentation is generated using
[Sphinx-doc](http://sphinx-doc.org/) and hosted on [Read the
Expand Down
2 changes: 1 addition & 1 deletion wiki/cloud_admin/identity_provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ One part of the registration process is also an opt in to the participation in e

## Step 2: Opt in for eduGAIN

In order to allow interfederational access for researchers, the [eduGAIN](https://edugain.org/) (EDUcation Global Authentication INfrastructure) project in the context of [GEANT](https://geant.org/Services/) was created.
In order to allow interfederational access for researchers, the [eduGAIN](https://edugain.org/) (EDUcation Global Authentication INfrastructure) project in the context of [GEANT](https://network.geant.org/services/) was created.
From a technical perspective eduGAIN aggregates the data of participating federations and serves the data to relying services.
By participating in the DFN you are free to decide whether your identity provider should also be referenced by eduGAIN.
Any conditions that must be met by the provider are listed on the [DFN eduGAIN page](https://wiki.aai.dfn.de/de:edugain#edugain_interfederation)
Expand Down
14 changes: 7 additions & 7 deletions wiki/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,25 @@ If the login was successful, you should see the overview page of the OpenStack d

----

At the top left you should see your current [project](../Concept/basics/#project) in the **de.NBI** [Domain](../Concept/basics/#domain) (green box). If you have more than one project, you can switch into another one here (click on the arrow down button).
At the top left you should see your current [project](Concept/basics.md#project) in the **de.NBI** [Domain](Concept/basics.md#domain) (green box). If you have more than one project, you can switch into another one here (click on the arrow down button).

At the top right you can see your [username](../Concept/basics/#user) (pink box). When you click on that arrow, you will get a dropdown menu. Here, you can get to your user specific settings (changing dashboard settings and appearance and your password), get to the official user documentation by OpenStack, change your theme or log out.
At the top right you can see your [username](Concept/basics.md#user) (pink box). When you click on that arrow, you will get a dropdown menu. Here, you can get to your user specific settings (changing dashboard settings and appearance and your password), get to the official user documentation by OpenStack, change your theme or log out.

On the left is the **control menu** (blue box) to navigate you through your project. The current page is highlighted in blue (In our case Project -> Compute -> Overview). This information can also be found in the yellow box. This could help you navigate to the right page, in the case you have trouble to find the current page we are operating on.

The overview page summarizes the resource allocation within the current project (center of the page):

* Launched [instances](../Concept/basics/#instance)
* Launched [instances](Concept/basics.md#instance)

* Used VCPUs

* Used RAM

* Allocated [ floating IPs ](../quickstart#floating-ip)
* Allocated [ floating IPs ](#floating-ip)

* Used [ security groups ](../quickstart#security-groups)
* Used [ security groups ](#security-groups)

* Number of [ Volumes ](../quickstart#using-cinder-volumes) and Volume Storage
* Number of [ Volumes ](#using-cinder-volumes) and Volume Storage

# SSH Setup

Expand Down Expand Up @@ -315,7 +315,7 @@ Click on **Associate** to associate your new floating ip to your instance. Now,

## Security Groups

First of all, you should read our [Security aspects in clouds](../security/#security-aspects-of-cloud-computing) page!
First of all, you should read our [Security aspects in clouds](security.md#security-aspects-of-cloud-computing) page!
You are responsible for a secure setup of your VMs. To allow external access to your instance via SSH, you have to change the security group and allow SSH! Go to Project -> Compute -> Access & Security

![nav compute](img/User/nav_project_compute_access_and_security.png)
Expand Down
Loading