Private Network (VPN) verbinden

Ein häufiges Szenario für die Nutzung eines VPN ist eine Anwendung, die auf Codesphere läuft und auf Dienste zugreifen muss, die in einem privaten Netzwerk gehostet werden. Ein Beispiel dafür ist die Verbindung zu einer On-Premise-Datenbank im eigenen Rechenzentrum des Unternehmens. Durch die Einrichtung einer VPN-Verbindung kannst du deine in Codesphere laufende Anwendung sicher mit deinem privaten Netzwerk verbinden, sodass deine Anwendungen mit internen Datenbanken, APIs oder anderen Diensten kommunizieren können, als befänden sie sich im selben lokalen Netzwerk.

Diese Anleitung führt dich durch die Erstellung einer VPN-Konfiguration und die Verbindung deiner Codesphere Workspaces mit einem VPN-Gateway mittels IPsec. Nach der Einrichtung baut jede Replica deines Workspace-Dienstes eine eigene individuelle VPN-Verbindung zu deinem VPN-Gateway auf.

Voraussetzungen & Einschränkungen​

Voraussetzungen:​

• Dein VPN-Gateway muss aus dem öffentlichen Internet erreichbar sein und eine statische öffentliche IP-Adresse besitzen.
• Das Gateway muss IPsec mit IKEv1 oder IKEv2 unterstützen.
• Der Pre-Shared Key (PSK) muss sowohl in der Codesphere VPN-Konfiguration als auch auf deinem Gateway identisch konfiguriert sein.
• Die IKE- und ESP-Cipher-Suites müssen auf beiden Seiten exakt übereinstimmen.

Einschränkungen:​

• Jede Workspace-Replica baut ihren eigenen individuellen VPN-Tunnel zu deinem Gateway auf. Dein Gateway muss so konfiguriert sein, dass es mehrere gleichzeitige Verbindungen von unterschiedlichen Quell-IPs akzeptiert.
  • Dies ist erforderlich, um das dynamische Hinzufügen und Entfernen von Anwendungsdiensten und deren Replicas zu unterstützen.
• Es handelt sich um eine Host-to-Site-Konfiguration, nicht um Site-to-Site. Codesphere Workspaces agieren als VPN-Clients, nicht als Netzwerk-Peer.
• Das Ändern einer VPN-Konfiguration startet den VPN-Dienst auf allen verbundenen Workspaces neu, was zu einer kurzen Netzwerkunterbrechung führt.
  • Es wird empfohlen, eine zweite VPN-Konfiguration mit einem duplizierten Workspace zu verwenden, um Änderungen ohne Ausfallzeit zu ermöglichen.

conn workspaces
  keyexchange=ikev1
  type=tunnel
  authby=psk
  forceencaps=yes
  ike=aes256-sha256-modp2048
  esp=aes256-sha256-modp2048
  ikelifetime=1h

  leftid=1.2.3.4 # Öffentliche IP des Gateways
  left=%defaultroute
  lifetime=8h
  leftsubnet=0.0.0.0/0

  right=%any
  rightsourceip=10.200.0.0/24 # Die interne Quell-IP, die in einem Tunnel für den entfernten Peer verwendet wird.

  auto=add

Konfiguration erstellen​

1. Navigiere zum Tab VPNs in deinem Team-Dashboard.
2. Klicke auf die Schaltfläche + Create VPN.

3. Gib einen Namen für die Verbindung ein.
4. Gib den Pre-Shared Key ein (stelle sicher, dass dieser mit deinem entfernten Gateway übereinstimmt).
5. Konfiguriere die IKE- und ESP-Einstellungen (Version, Lifetime, Cipher Suites).

6. Suche den Abschnitt „Network Settings“.
7. Gib die Peer IP ein (die öffentliche IP deines VPN-Gateways).
8. Gib die Peer Subnet(s) an.

9. Speichere die Konfiguration.

Workspaces verbinden​

1. Klicke auf den neu erstellten VPN-Namen, um dessen Details zu öffnen.
2. Wähle den Tab Connected Workspaces aus.
3. Verwende das Dropdown Add Workspaces, um die Ziel-Landscapes auszuwählen, die du mit diesem VPN verbinden möchtest.

Verbindung überprüfen​

Sobald deine Workspaces verbunden sind, solltest du den Tunnel testen, um sicherzustellen, dass der Datenverkehr korrekt geroutet wird.

1. Öffne das Terminal in deiner Codesphere IDE.
2. Sende einen Ping an eine private IP-Adresse innerhalb des zuvor definierten Peer Subnet.
   • Beispielbefehl: ping 10.250.0.5
3. Bestätige, dass der Ping erfolgreich ist, um zu überprüfen, dass der Tunnel aktiv ist und Verkehr erfolgreich durchleitet.

Preview Deployments via CI/CD​

Du kannst Preview Deployments auch über unsere CI-Integrationen für GitHub, Bitbucket und GitLab mit bestehenden VPN-Verbindungen verknüpfen. So kannst du komfortabel mit privaten Netzwerken (z. B. eingeschränkten On-Premise-Datenbanken oder internen APIs) für deine Entwicklungsumgebungen arbeiten.

Um dies einzurichten, referenziere einfach den Namen deiner VPN-Verbindung in der Deploy-YAML deines Repositorys.

- name: Deploy
  uses: codesphere-cloud/gh-action-deploy@main
  env:
    GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
  with:
    email: ${{ secrets.CODESPHERE_EMAIL }}
    password: ${{ secrets.CODESPHERE_PASSWORD }}
    team: 'My Team' # Ändere dies zu deinem Team
    plan: 'Boost' # Wähle den Plan für deine App
    onDemand: 'true' 
    vpnConfig: 'vpnConfigName' # Durch den Namen deiner VPN-Verbindung ersetzen

codesphere-deploy:
  image: ghcr.io/codesphere-cloud/codesphere-monorepo/integrations/gitlab-ci:latest
  stage: deploy
  script:
    - /app/server
  variables:
    ACCESS_TOKEN: $CI_ACCESS_TOKEN
    EMAIL: $CODESPHERE_EMAIL
    PASSWORD: $CODESPHERE_PASSWORD
    TEAM: 'Demo'
    PLAN: 'Micro'
    ON_DEMAND: 'false'
    VPN_CONFIG: 'vpnConfigName' # Durch den Namen deiner VPN-Verbindung ersetzen

- step:
    deployment: Test
    script:
      - pipe: docker://ghcr.io/codesphere-cloud/codesphere-monorepo/integrations/bitbucket-ci:latest
        variables:
          ACCESS_TOKEN: $ACCESS_TOKEN
          EMAIL: $CODESPHERE_EMAIL
          PASSWORD: $CODESPHERE_PASSWORD
          TEAM: 'My Team'
          PLAN: 'Micro'
          VPN_CONFIG: 'vpnConfigName' # Durch den Namen deiner VPN-Verbindung ersetzen