Main Page: Difference between revisions

From bwCloud-OS
Jump to navigation Jump to search
Admin (talk | contribs)
Created page with "= Willkommen zur [https://bwcloud-os.de bwCloud-OS]-Dokumentation = __NOTOC__ = Quickstart = '''Create VM''' # Log in to the [https://dashboard.bw-cloud.org bwCloud-OS Dashboard] and select the desired '''Region''' in the top left corner. # Under ''Compute → Key Pairs'', upload an existing SSH public key '''or''' create a new key pair. # Go to ''Compute → Instances → Launch Instance'' and fill out the tabs one by one: ## '''Details:''' Assign a name. ## '''So..."
 
No edit summary
 
(97 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Willkommen zur [https://bwcloud-os.de bwCloud-OS]-Dokumentation =
__NOTOC__
__NOTOC__
= bwCloud-OS User Wiki =
Welcome to the '''bwCloud-OS User Wiki -''' the central guide to using the multi-region '''O'''pen'''S'''tack '''cloud''' shared across '''B'''aden-'''W'''ürttemberg, Germany. This cloud is jointly operated by the universities of Freiburg, Karlsruhe, Mannheim, and Ulm, and is available to users from all participating educational institutions.


This wiki is primarily designed to answer '''frequently asked questions (FAQs)''' and provide '''practical guidance''' for common tasks when using the bwCloud-OS service. General information about the bwCloud-OS  and related projects is available on the [https://bwcloud-os.de/ '''bwCloud-OS website'''].


If you need technical assistance beyond what is covered here, please open a support '''ticket''' via the [https://bw-support.scc.kit.edu/ '''bwSupportPortal'''].


== Quickstart ==
<span id="Quickstart"></span>


<br>


= Quickstart =
{{Box
'''Create VM'''
|id=register1
# Log in to the [https://dashboard.bw-cloud.org bwCloud-OS Dashboard] and select the desired '''Region''' in the top left corner.  
|title=I. Register and/or Log in
# Under ''Compute → Key Pairs'', upload an existing SSH public key '''or''' create a new key pair.
|content=
# Go to ''Compute → Instances → Launch Instance'' and fill out the tabs one by one:
<ol>
## '''Details:''' Assign a name.
  <li>Go to the bwCloud-OS [https://portal.bw-cloud.org/ Dashboard].</li>
## '''Source:''' Choose an [[Images|Image]] (e.g. Debian 12).
  <li>Select '''bwIDM via OpenID Connect''' and click '''Sign In'''.</li>
## '''Flavor:''' Select a [[bwCloud-OS Bereitgestellete-Flavors|Hardware Flavor]] (e.g. <code>m1.small</code>).
  <li>Choose your home institution and log in with your university credentials.</li>
## '''Networks:''' Select the appropriate network.
<li>If logging in for the first time, register for <strong>bwCloud SCOPE</strong> by accepting the terms of use.</li>
## '''Key Pairs:''' Choose your [[Quickstart: SSH-Key hinterlegen|SSH key pair]].
  <li>After login or registration, you will be redirected to the bwCloud-OS Dashboard.</li>
## Click ''Launch''.
</ol>
# Connect: <code>ssh -i /path/to/key &#x3C;user&#x3E;@&#x3C;IP-address&#x3E;</code> (for Debian/Ubuntu: user <code>debian</code> or <code>ubuntu</code>). Username overview [[Images|here]].
<br>
= Themen-Hub =
See the [[Registration|Registration page]] for more details.
; [[Registrierung]]
}}
: entitlements, regions
;  [[Instanzen (VMs)|Instances (VMs)]]
: VMs starten, verbinden (SSH), Images/Flavors, Snapshots
; [[Netzwerk & Sicherheit (Portal)|Network & Security]]
: Floating-IP, Security Groups, eigenes Netz/Router, DNS/FQDN
; [[Speicher|Storage]]
: Volumes, Performance, Backups
; (Group[[(Gruppen-)Projekte & Quota|-)Projects & Quota]]
: Beantragen, Rollen, Entitlements, Gruppenprojekte
; [[Automatisierung & Tools|Automation & Tools]]
: Ansible, API-Zugriff




== Hinweise ==
{{Box
; Netzwerk/Ports
|id=register2
: Siehe [[Referenz: Netzwerk – gesperrte/erlaubte Ports]].
|title=II. Upload or Create an SSH Key
; Support
|content=
: [https://bw-support.scc.kit.edu Support: Ticket eröffnen]
<ol>
; Begriffe
  <li>Log in to the [https://portal.bw-cloud.org/ Dashboard].</li>
: [[Glossar]]  
  <li>Go to <strong>Project → Compute → Key Pairs</strong>.</li>
:
  <li>
    Choose one of the following options:
    <ul>
      <li><strong>To import an existing key</strong>: Click <strong>Import Public Key</strong>, enter a name, select <strong>SSH Key</strong> type, and upload your '''''public''''' SSH key. Then click <strong>Import</strong>.</li>
      <li><strong>To create a new key pair</strong>: Click <strong>Create Key Pair</strong>, enter a name, select <strong>SSH Key</strong> type, and click <strong>Create</strong>. The '''''private''''' key will be downloaded automatically.</li>
    </ul>
  </li>
  <li>Make sure the private key is securely stored and accessible on your local machine.</li>
</ol>
<br>For help generating an SSH key, see our [[Guide: SSH#Key-Pair-Creation|SSH Guide]].
}}
 
 
{{Box
|id=register3
|title=III. Launch a Virtual Machine
|content=
 
<ol>
  <li>
    Go to <strong>Compute → Instances → Launch Instance</strong> and fill out the tabs:
    <ol type="a" style="margin-left: 1.5em;">
      <li><strong>Details</strong>: Assign a name</li>
      <li><strong>Source</strong>: Choose an image (e.g., ''Debian 12'')</li>
      <li><strong>Flavor</strong>: Select a resource package (e.g., ''m1.small'')</li>
      <li><strong>Networks</strong>: Choose the appropriate  network</li>
      <li><strong>Key Pair</strong>: Select your SSH key</li> </ol>
  </li>
  <li>Click <strong>Launch</strong> and wait for the instance to finish building and enter <strong>Running</strong> state.</li>
</ol>
<br>For full details on managing instances, see  the [[Instances (VMs)|Instances page]].
}}
 
 
{{Box
|id=register4
|title=IV. Connect to Your VM
|content=
Connect to your VM via SSH from a terminal using the following command:
 
<pre style="background-color: #f9f9f9; border: 1px solid #ccc; padding: 0.5em;">
ssh -i /path/to/private-key &lt;user&gt;@&lt;address&gt;
</pre>
<ul>
<li>
<code><user></code> is the default username, e.g. <code>ubuntu</code> for Ubuntu images. For other images, see the [[Images|Image Overview]].
</li>
<li>
<code><address></code> is the DNS name ([[Networks#FQDN|FQDN]]) or the public IP address of your running instance. Both can be found in the [https://portal.bw-cloud.org/ Dashboard], on the <strong>Instances</strong> page.  
</li>
</ul>
</p>
<br>For (advanced) SSH connection methods, see our [[Guide: SSH|SSH Guide]].
}}
 
 
== Topic Hub '''–''' Sections == 
<span id="Theme-Hub"></span>
 
* '''🆔 [[Registration]]''' '''–''' Identity Management, Entitlements, Regions
* '''🖥️ [[Instances (VMs)]] –''' Launching Virtual Machines (VMs), Access to VMs (SSH), Flavors, Images
* '''🌐 [[Networks]]''' '''–''' IPs, FQDNs & DNS, Public and Private Networks
* '''[[Security|🛡️ Security]]''' '''–''' Open and Closed Ports, Security Groups, Security Incidents
* '''💾 [[Storage]]''' '''–''' Volumes, Snapshots, Backups
* '''👥''' '''[[Projects and Quota|Projects & Quota]]''' '''–''' Projects, Group Management, Quota Changes
* '''⚙️ [[Programmatic Access and Automation|Automation]]''' '''–''' API Access, Automation Tools (e.g., Ansible, Terraform)
 
== Other Notes ==
 
<ul style="list-style: none; padding-left: 0;">
  <li>
  '''📖 [[Glossary]]''' - <span style="color: #444;">Key Terms Used in bwCloud-OS</span>
  </li>
</ul>

Latest revision as of 18:04, 10 November 2025

bwCloud-OS User Wiki

Welcome to the bwCloud-OS User Wiki - the central guide to using the multi-region OpenStack cloud shared across Baden-Württemberg, Germany. This cloud is jointly operated by the universities of Freiburg, Karlsruhe, Mannheim, and Ulm, and is available to users from all participating educational institutions.

This wiki is primarily designed to answer frequently asked questions (FAQs) and provide practical guidance for common tasks when using the bwCloud-OS service. General information about the bwCloud-OS and related projects is available on the bwCloud-OS website.

If you need technical assistance beyond what is covered here, please open a support ticket via the bwSupportPortal.

Quickstart


I. Register and/or Log in

  1. Go to the bwCloud-OS Dashboard.
  2. Select bwIDM via OpenID Connect and click Sign In.
  3. Choose your home institution and log in with your university credentials.
  4. If logging in for the first time, register for bwCloud SCOPE by accepting the terms of use.
  5. After login or registration, you will be redirected to the bwCloud-OS Dashboard.


See the Registration page for more details.


II. Upload or Create an SSH Key

  1. Log in to the Dashboard.
  2. Go to Project → Compute → Key Pairs.
  3. Choose one of the following options:
    • To import an existing key: Click Import Public Key, enter a name, select SSH Key type, and upload your public SSH key. Then click Import.
    • To create a new key pair: Click Create Key Pair, enter a name, select SSH Key type, and click Create. The private key will be downloaded automatically.
  4. Make sure the private key is securely stored and accessible on your local machine.


For help generating an SSH key, see our SSH Guide.


III. Launch a Virtual Machine

  1. Go to Compute → Instances → Launch Instance and fill out the tabs:
    1. Details: Assign a name
    2. Source: Choose an image (e.g., Debian 12)
    3. Flavor: Select a resource package (e.g., m1.small)
    4. Networks: Choose the appropriate network
    5. Key Pair: Select your SSH key
  2. Click Launch and wait for the instance to finish building and enter Running state.


For full details on managing instances, see the Instances page.


IV. Connect to Your VM

Connect to your VM via SSH from a terminal using the following command:

ssh -i /path/to/private-key <user>@<address>
  • <user> is the default username, e.g. ubuntu for Ubuntu images. For other images, see the Image Overview.
  • <address> is the DNS name (FQDN) or the public IP address of your running instance. Both can be found in the Dashboard, on the Instances page.


For (advanced) SSH connection methods, see our SSH Guide.


Topic Hub Sections

  • 🆔 Registration Identity Management, Entitlements, Regions
  • 🖥️ Instances (VMs) Launching Virtual Machines (VMs), Access to VMs (SSH), Flavors, Images
  • 🌐 Networks IPs, FQDNs & DNS, Public and Private Networks
  • 🛡️ Security Open and Closed Ports, Security Groups, Security Incidents
  • 💾 Storage Volumes, Snapshots, Backups
  • 👥 Projects & Quota Projects, Group Management, Quota Changes
  • ⚙️ Automation API Access, Automation Tools (e.g., Ansible, Terraform)

Other Notes

  • 📖 Glossary - Key Terms Used in bwCloud-OS