Skip to content

docs: add IRSA instructions #478

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
max-ae wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add IRSA instructions #478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions web/docs/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ As you can see, the contents of `barmanObjectStore` have been copied directly
under the `configuration` field of the `ObjectStore` resource, using the same
secret references.

### IAM Role for Service Account (IRSA)

If you use IRSA, you need to configure the `ObjectStore` to utilize the correct role as described in the [`Object Store Reference`](object_stores.md#iam-role-for-service-account-irsa).
Comment on lines +106 to +108
Copy link
Contributor

@GabriFedi97 GabriFedi97 Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section shouldn't be focusing on showing different authentication mechanisms but it should instead illustrate that whatever configuration is applied to the Cluster spec.backup.barmanObjectStore has to be reflected in the ObjectStore spec.configuration.
This is also mentioned below:

As you can see, the contents of barmanObjectStore have been copied directly under the configuration field of the ObjectStore resource, using the same secret references.


## Step 2: Update the `Cluster` for plugin WAL archiving

Once the `ObjectStore` resource is in place, update the `Cluster` resource as
Expand Down
13 changes: 13 additions & 0 deletions web/docs/object_stores.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,19 @@ spec:
[...]
```

In addition, configure the `ObjectStore` to inherit permissions from the IAM role referenced in the service account:

```yaml
apiVersion: barmancloud.cnpg.io/v1
kind: ObjectStore
metadata:
[...]
spec:
configuration:
s3Credentials:
inheritFromIAMRole: true
```

### S3 Lifecycle Policy

Barman Cloud uploads backup files to S3 but does not modify or delete them afterward.
Expand Down