Skip to content

Commit

Permalink
Merge pull request #1946 from StatCan/bryan-update-blob-csi-docs
Browse files Browse the repository at this point in the history
Update blob csi docs to be more accurate.
  • Loading branch information
bryanpaget authored Jan 24, 2024
2 parents 6fc0da9 + 680ed20 commit b7aa33a
Showing 1 changed file with 38 additions and 31 deletions.
69 changes: 38 additions & 31 deletions docs/dev/features/object-storage/blobcsi.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,41 +165,45 @@ resource "kubernetes_secret" "aaw-<acronym>-prod-sp-secret" {

#### c. Add bucket info:


Add the following to `resource "kubectl_manifest" "fdi-aaw-configuration-data"`, in one of:
Add the following to `resource "kubectl_manifest" "fdi-aaw-configuration-data"`, in one of the following, depending on the classification of the bucket:

1. `fdi-protected-b-external.json: |` or
2. `fdi-unclassified-external.json: |` or
3. `fdi-protected-b-internal.json: |` or
4. `fdi-unclassified-internal.json: |`

depending on the classification of the bucket.

```
{
"bucketName": "<should-be-provided-for-you>",
"pvName": "<acronym>-eprotb",
"subfolder": "",
"readers": ["<name-of-kuebeflow-profile>"],
"writers": ["<name-of-kuebeflow-profile>"],
"spn": "aaw-<acronym>-prod-sp"
},
{
"bucketName": "<should-be-provided-for-you>-transit",
"pvName": "<acronym>-inbox-eprotb",
"subfolder": "from-de",
"readers": ["<name-of-kuebeflow-profile>"],
"writers": ["<name-of-kuebeflow-profile>"],
"spn": "aaw-<acronym>-prod-sp"
},
{
"bucketName": "<should-be-provided-for-you>-transit",
"pvName": "<acronym>-outbox-eprotb",
"subfolder": "to-vers",
"readers": ["<name-of-kuebeflow-profile>"],
"writers": ["<name-of-kuebeflow-profile>"],
"spn": "aaw-<acronym>-prod-sp"
}
{
"bucketName": "<should-be-provided-for-you>",
"pvName": "<acronym>-eprotb",
"subfolder": "",
"readers": ["<name-of-kuebeflow-profile>"],
"writers": ["<name-of-kuebeflow-profile>"],
"spn": "aaw-<acronym>-prod-sp"
}
```

##### Transit Containers

If the storage solution requires transit containers, you'll want to add this as well. Not all solutions require this.

```
{
"bucketName": "<should-be-provided-for-you>-transit",
"pvName": "<acronym>-inbox-eprotb",
"subfolder": "from-de",
"readers": ["<name-of-kuebeflow-profile>"],
"writers": ["<name-of-kuebeflow-profile>"],
"spn": "aaw-<acronym>-prod-sp"
},
{
"bucketName": "<should-be-provided-for-you>-transit",
"pvName": "<acronym>-outbox-eprotb",
"subfolder": "to-vers",
"readers": ["<name-of-kuebeflow-profile>"],
"writers": ["<name-of-kuebeflow-profile>"],
"spn": "aaw-<acronym>-prod-sp"
}
```

##### Info
Expand All @@ -214,19 +218,22 @@ depending on the classification of the bucket.
>
> `writers:` use the kubeflow profile name for this
>
> `spn:` this has to be created by YOU. Send a JIRA ticket to the Cloud Team.
> `spn:` this has to be obtained by you by sending a Jira ticket to the Cloud Team. See below for an example SPN request.
>
##### Example Cloud Ticket

To obtain the SPN, send a Jira ticket to the Cloud Team, follow the template below:

> Hi,
>
> Can I get a service principle named aaw-\<acronym\>-prod-sp created please?
>
> The owners should be:
>
> [email protected]
> [email protected]
> - [email protected]
> - [email protected]
>
> More info: https://jirab.statcan.ca/browse/?????-????
>
> Thanks!
Expand Down

0 comments on commit b7aa33a

Please sign in to comment.