Opslag configureren

Sommige delen van deze instructies gebruiken optioneel ricloud-py om de installatie te vereenvoudigen. Om hier gebruik van te maken, bekijk de installatie- en configuratie- documentatie voor ricloud-py .

De opslagconfiguratie vertelt de API waar de resultaten van uw taken moeten worden geretourneerd. Momenteel ondersteunen we opslagopslagplaatsen van zowel Google Cloud Storage (GS) als Amazon S3 (S3).

Opslag instellen met Google Cloud Storage

Een Google Cloud Platform-project maken

Als u niet beschikt over een Google Cloud Platform (GCP) account die u nodig hebt om te krijgen ondertekend . Klik gewoon op 'Probeer gratis' (of 'Probeer het gratis') om het aanmeldingsproces te doorlopen.

Vervolgens hebt u een project nodig om uw opslagbunker onder te brengen. Mogelijk is er eentje automatisch aangemaakt tijdens het aanmelden of wilt u misschien een nieuw, afzonderlijk project alleen voor dit doel. U kunt aanvullende instructies vinden over het beheren van projecten in de Google Cloud-documenten .

Een Google Cloud Storage-bucket maken

Nu het GCP-project gereed is, kunt u doorgaan en een nieuwe opslagbunker maken . We raden aan om ten minste de 'Regionale' opslagklasse en de 'us-east1'-locatie te gebruiken (dit is waar de meeste van onze bronnen zich bevinden). Voor deze gids noemen we onze bucket ricloud-storage , maar je zult waarschijnlijk een andere naam moeten kiezen omdat bucket-namen wereldwijd uniek zijn in hun host-service.

Een serviceaccount maken voor de API

Nadat de bucket is geïnitialiseerd, moet u een serviceaccount maken om de API toegang te verlenen. Een serviceaccount is in wezen een robotgebruiker van uw project waaraan we machtigingen kunnen verlenen om alleen toegang te krijgen tot onze nieuwe bucket. Ga je gang en volg de stappen in de Google Cloud IAM-documenten om een serviceaccount in te stellen. De naamkeuze is aan jou, maar in deze gids zullen we het ricloud-sa noemen. Negeer alle optionele velden bij het maken van het serviceaccount, we zullen in een latere stap permissies instellen.

Als u ervoor kiest om een sleutel te maken in de laatste stap van het proces, moet u dit veilig houden omdat dit het bestand is dat we later aan de API zullen geven. Maak anders anders een sleutel door deze stappen te volgen .

Machtigingen op bucketniveau instellen

Ga terug naar het gedeelte Opslag van uw GCP-project en volg de stappen in ' Documenten toevoegen aan ricloud-sa ' in de Google Cloud Storage-documenten om het ricloud-sa serviceaccount toe te voegen. Geef het de rollen 'Storage Object Creator' en 'Storage Legacy Bucket Reader'.

De configuratie maken

Op dit moment moet de serviceaccount volledig zijn ingesteld en klaar zijn om met de API te worden gebruikt.

Ricloud-py gebruiken om de configuratie te maken

Met ricloud-py kun je een nieuwe opslagconfiguratiebron maken met de opdracht:

> ricloud storage-config create --url "<storage bucket url>" --credentials-path <path to credentials file>

Waar storage bucket url in ons geval het bestand gs://ricloud-storage en path to credentials file is dit slechts het pad naar het sleutelbestand van de serviceaccount dat we eerder hebben gemaakt.

Met behulp van cURL om de configuratie te maken

curl -X POST \
  https://ricloud-api.reincubate.com/configs/storage \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "gs://ricloud-storage",
    "credentials": <all contents of the Service Account JSON key file>
}'

Opslag instellen met Amazon S3

Een Amazon AWS-account maken

Als je geen Amazon AWS-account hebt, moet je je aanmelden. Klik op 'Aan de slag met Amazon S3' om het installatieproces te doorlopen.

Een S3-opslagbucket maken

Volg deze instructies van de AWS-documenten om een bucket-setup in S3 te krijgen. Kies een naam die je wilt, voor deze gids zullen we ricloud-storage . We raden aan deze in 'US East (N. Virginia)' te zoeken voor de nabijheid van de resources van de API.

Een gebruiker maken voor de API

Zodra de bucket klaar is voor gebruik, moet u een nieuwe gebruiker instellen met beperkte rechten voor de nieuwe bucket voor de API die moet worden gebruikt. Dit gebeurt via het IAM-console via deze stappen . Geef de gebruiker een gedenkwaardige naam, zoals ricloud-user en zorg ervoor dat ze zijn ingesteld voor 'Programmatic access'.

We moeten een aangepast beleid maken, omdat wanneer er wordt gevraagd om de gebruikersrechten te geven, er geen standaardbeleid is dat aan onze behoeften voldoet. Voor standaardpublicatie van resultaten vereist de API de toestemming s3:PutObject .

Selecteer in de AWS-beleidseditor 'Bestaand beleid rechtstreeks bijvoegen', klik op 'Beleid maken' (dit zou een nieuw tabblad moeten openen), selecteer vervolgens het tabblad 'JSON' (dat zal overschakelen naar de JSON-beleidseditor) en plak het volgende in :

{
    "Version": "2012-10-17",
    "Statement": [{
        "Effect": "Allow",
        "Action": [
            "s3:PutObject"
        ],
        "Resource": ["arn:aws:s3:::ricloud-storage/*"]
    }]
}

Zorg ervoor dat je de ricloud-storage bucket vervangt door de naam van de bucket die je eerder noemde. Ga door om het nieuwe beleid op te slaan, noem het wat je maar wilt.

Ga terug naar de stroom voor het maken van gebruikers en zorg ervoor dat de gebruiker ons nieuwe beleid hieraan heeft gekoppeld.

Aan het einde van het proces voor het maken van de gebruiker toont de interface de 'Toegangscode ID' en 'Geheime toegangscode'. Bewaar deze daarom veilig. U kunt de inloggegevens ook downloaden in CSV-indeling.

De configuratie maken

Op dit punt moet de gebruiker volledig zijn ingesteld en klaar om te worden gebruikt met de API. Met ricloud-py kun je een nieuwe opslagconfiguratiebron maken met de opdracht:

> ricloud storage-config create --url "<storage bucket url>" --credentials-path <path to credentials file>

Waar storage bucket url in dit geval zou zijn s3://ricloud-storage en het path to credentials file is gewoon het pad naar de geloofsbrieven CSV-bestand geëxporteerd aan het einde van de gebruiker creatie proces of een JSON-bestand met de gebruiker referentiegegevens in de S3-inloggegevensopmaak .

De equivalente cURL-aanroep zou er als volgt uitzien:

curl -X POST \
  https://ricloud-api.reincubate.com/configs/storage \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "s3://ricloud-storage",
    "credentials": {
        "user_name": "ricloud-user",
        "access_key_id": "<user access key ID>",
        "secret_access_key": "<user secret access key>",
    }
}'