Skip to content

Commit

Permalink
Merge pull request #25 from Trou1994/addplusstorage
Browse files Browse the repository at this point in the history
Redesign the Storage Section
  • Loading branch information
frosty-geek authored Feb 15, 2024
2 parents 731a2d3 + 706e2b9 commit 5b7bdbb
Show file tree
Hide file tree
Showing 82 changed files with 4,988 additions and 1,704 deletions.
18 changes: 15 additions & 3 deletions content/de/storage-backup/s3-storage/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
---
title: "S3 Storage"
linkTitle: "S3 Storage"
title: "plusserver S3 Storage"
linkTitle: "plusserver S3 Storage"
type: "docs"
weight: 10
---

The german version of this product is under contruction. Please use the english version.
Willkommen zur Dokumentation für den S3 Storage von PlusStorage. Hier finden Sie alle Informationen, die Sie für einen perfekten Start benötigen.

{{% alert title="Warning" color="warning" %}}
Die in dieser Kundendokumentation enthaltenen Informationen dienen lediglich als Beispiele und Orientierungshilfe für die Konfiguration von S3-Buckets und -Objekten. plusserver übernimmt keine Verantwortung für eventuelle Konsequenzen oder Schäden, die durch fehlerhaft konfigurierte Buckets oder Objekte entstehen könnten.

Alle Befehle, Einstellungen und Funktionen sollten mit äußerster Vorsicht und Bedacht ausgeführt werden.

Bitte beachten Sie, dass die hier bereitgestellten Schritte als Inspiration dienen sollen. Es wird dringend empfohlen, die [AWS-Dokumentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) sowie andere vertrauenswürdige Quellen zu Rate zu ziehen und Ihre Konfiguration anhand Ihrer individuellen Anforderungen und Geschäftsfälle anzupassen und vorher in einer Testumgebung zu testen.

Es liegt in Ihrer Verantwortung sicherzustellen, dass Ihre S3-Konfiguration den besten Praktiken, Sicherheitsrichtlinien und Compliance-Anforderungen entspricht.

Wenn Sie sich unsicher sind oder Fragen zur Konfiguration haben, wenden Sie sich bitte an unseren Kundenservice oder rufen Sie die offizielle [AWS-Dokumentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html) auf, um die für Ihre Anforderungen optimale Konfiguration zu wählen.
{{% /alert %}}
10 changes: 10 additions & 0 deletions content/de/storage-backup/s3-storage/documentation/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Dokumentation"
linkTitle: "Dokumentation"
type: "docs"
weight: 20
description: "Erläuterungen zu verschiedenen Funktionen des plusserver S3"
date: 2024-02-06
---

Entdecken Sie in unserer PlusServer S3-Dokumentation umfassende Informationen zu den grundlegenden Funktionen und der Einrichtung des plusserver S3-Services für eine effiziente und sichere Datenspeicherung.

Large diffs are not rendered by default.

131 changes: 131 additions & 0 deletions content/de/storage-backup/s3-storage/documentation/s3-tenant-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
---
title: "plusserver S3 Tenant-API-Dokumentation"
linkTitle: "S3 Tenant-API"
type: "docs"
weight: 30
date: "2024-02-07"
---

Die Tenant-API des plusserver S3-Dienstes bietet eine umfassende Schnittstelle für verschiedene Funktionen, um das Mandantenmanagement effektiv zu steuern und zu verwalten. Hier finden Sie eine Übersicht über die wichtigsten Aspekte der API und wie Sie sie verwenden können.

### Was ist die Tenant-API?

Die Tenant-API ermöglicht es Ihnen, verschiedene Operationen im Zusammenhang mit dem Mandantenmanagement durchzuführen. Ein Mandant repräsentiert dabei einen Benutzer oder eine Gruppe von Benutzern und deren zugehörige Ressourcen im S3-Dienst. Mit der Tenant-API können Sie spezifische Aktionen auf Mandantenkonten, Authentifizierung, Konfigurationen, Objektverwaltung und mehr durchführen.

### Wie ruft man die Dokumentation auf?

Sie können die vollständige API-Dokumentation unter [https://s3-portal.psmanaged.com:9443/ui/apidocs.html#](https://s3-portal.psmanaged.com:9443/ui/apidocs.html#) aufrufen. Dort finden Sie detaillierte Informationen zu den verfügbaren Endpunkten, Authentifizierungsschemas, unterstützten Versionen und den verschiedenen Operationen, die Sie durchführen können.

### Verfügbare Funktionen

Die Mandantenmanagement-API organisiert die verfügbaren Funktionen in verschiedene Abschnitte:

- **Account:** Betrieb auf dem aktuellen Mandantenkonto, einschließlich der Speicherung von Informationen zur Nutzung.

- **Auth:** Operationen zur Authentifizierung der Benutzersitzung, mit Unterstützung des Authentifizierungsschemas für das Inhabertoken.

- **Config:** Operationen bezogen auf die Produktversion und Versionen der Mandantenmanagement-API. Sie können die Produktversion und die Hauptversionen der von dieser Version unterstützten API auflisten.

- **Container:** Betrieb auf S3-Buckets oder Swift-Containern, einschließlich Funktionen wie Bucket-Erstellung, Konsistenzsteuerung, CORS-Konfiguration, Objektupdates und mehr.

- **Deaktivierte Funktionen:** Anzeigen von Funktionen, die möglicherweise deaktiviert wurden.

- **Endpunkte:** Operationen zur Verwaltung von Endpunkten, die einem S3-Bucket ermöglichen, externe Services für Replikation, Benachrichtigungen oder Suchintegration zu verwenden.

- **Groups:** Operationen zur Verwaltung lokaler Mandantengruppen und zum Abrufen von verbundenen Mandantengruppen aus einer externen Identitätsquelle.

- **Identity-Source:** Operationen zum Konfigurieren einer externen Identitätsquelle und manuellen Synchronisieren von föderierten Gruppen- und Benutzerinformationen.

- **Regionen:** Operationen zur Bestimmung, welche Regionen für das StorageGRID-System konfiguriert wurden.

- **s3:** Betrieb zum Verwalten von S3-Zugriffsschlüsseln für Mandantenbenutzer.

- **s3-Object-Lock:** Operationen auf globalen S3 Object Lock Einstellungen zur Unterstützung der Einhaltung gesetzlicher Vorschriften.

- **Benutzer:** Operationen zum Anzeigen und Verwalten von Mandantenbenutzern.

Nutzen Sie die umfassenden Funktionen der Tenant-API, um Ihr Mandantenmanagement effizient zu steuern und anzupassen.


## plusserver S3 Usage via API Query

In diesem Abschnitt erfahren Sie, wie Sie die Nutzungsinformationen für Ihren plusserver S3-Service abrufen können. Damit erhalten Sie Einblicke in die Verwendung Ihrer Buckets via API Abfrage.

### Schritt 1: API-Dokumentation abrufen

Bevor Sie mit der Abfrage von S3 Usage beginnen, können Sie die API-Dokumentation über den folgenden Link abrufen: [API-Dokumentation](https://s3-portal.psmanaged.com:9443/ui/apidocs.html#).

### Schritt 2: Autorisierungstoken erhalten

Um auf die S3 Usage-Daten zuzugreifen, benötigen Sie ein Autorisierungstoken. Sie können das Token über eine POST-Anfrage an die folgende URL erhalten:
[https://s3-portal.psmanaged.com:9443/api/v3/authorize](https://s3-portal.psmanaged.com:9443/api/v3/authorize)

Verwenden Sie den folgenden JSON-Body in Ihrer Anfrage und ersetzen Sie `<accountId>`, `<username>` und `<password>` durch Ihre entsprechenden Informationen:
```json
{
"accountId": "Ihre_Account_ID",
"username": "Ihr_Benutzername",
"password": "Ihr_Passwort",
"cookie": true,
"csrfToken": false
}
```

Die Antwort enthält Ihr Autorisierungstoken, die Sie für die weiteren Schritte verwenden können.

**Beispiel Curl-Anfrage für die Autorisierung:**

```bash
curl -X POST -H "Content-Type: application/json" -d '{
"accountId": "Ihre_Account_ID",
"username": "Ihr_Benutzername",
"password": "Ihr_Passwort",
"cookie": true,
"csrfToken": false
}' "https://s3-portal.psmanaged.com:9443/api/v3/authorize"
```

### Schritt 3: S3 Usage abrufen

Verwenden Sie Ihr Autorisierungstoken, um die S3 Usage-Daten abzurufen. Nutzen Sie dazu eine GET-Anfrage an die folgende URL:
[https://s3-portal.psmanaged.com:9443/api/v3/org/usage](https://s3-portal.psmanaged.com:9443/api/v3/org/usage)

Fügen Sie Ihrem Anfrageheader das Autorisierungstoken hinzu:
**-H "Authorization: Bearer Ihr_Autorisierungstoken"**

Die Antwort enthält umfassende Informationen zur Nutzung, einschließlich der Anzahl der Objekte, der Datenmenge und der Informationen zu Ihren Buckets.

### Schritt 4: Speichern der Usage-Daten

Um die erhaltenen Usage-Daten zu speichern, können Sie **beispielsweise** ein einfaches Bash-Skript verwenden. Hier ist ein **Beispiel**, wie Sie die Daten abrufen und als JSON-Datei speichern können:

```bash
#!/bin/bash

# Autorisierungstoken abrufen
auth_token=$(curl -X POST -H "Content-Type: application/json" -d '{
"accountId": "Ihre_Account_ID",
"username": "Ihr_Benutzername",
"password": "Ihr_Passwort",
"cookie": true,
"csrfToken": false
}' "https://s3-portal.psmanaged.com:9443/api/v3/authorize" | jq -r '.data')

# S3 Usage-Daten abrufen
usage_data=$(curl -X GET "https://s3-portal.psmanaged.com:9443/api/v3/org/usage" -H "accept: application/json" -H "Authorization: Bearer $auth_token")

# Datum für Dateinamen generieren
timestamp=$(date +"%Y%m%d%H%M%S")

# Daten als JSON speichern
echo "$usage_data" > "usage_$timestamp.json"

echo "Usage-Daten wurden als usage_$timestamp.json gespeichert."
```
Führen Sie dieses Skript aus, um Ihre S3 Usage-Daten abzurufen und als JSON-Datei zu speichern.

{{% alert title="Info" %}}
Bitte beachten Sie, dass Sie Ihre eigenen Anmeldeinformationen und Account-IDs verwenden müssen, um die API-Anfragen durchzuführen.
{{% /alert %}}

---
Loading

0 comments on commit 5b7bdbb

Please sign in to comment.