Skip to content

Commit 2fefbd6

Browse files
committed
Add documentation.
1 parent 70bc696 commit 2fefbd6

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

admin-cli/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,39 @@ katta storageprofile aws sts \
5757
- `--roleNamePrefix`: Prefix used for IAM role names. Defaults to `katta-`.
5858
- `--bucketPrefix`: Prefix used when creating buckets for this storage profile. Defaults to `katta-`.
5959

60+
### Configure storage profile for MinIO using `storageprofile` command
61+
62+
Uploads a storage profile to Katta Server for use with MinIO STS. Requires MinIO STS setup with an OIDC provider.
63+
64+
Unlike AWS, MinIO does not support role chaining, so the same role ARN is used for both bucket creation and hub access.
65+
MinIO uses the `${jwt:client_id}` policy variable to scope bucket access per vault.
66+
67+
See also: [MinIO setup documentation](https://github.com/shift7-ch/katta-docs/blob/main/SETUP_KATTA_SERVER.md#minio).
68+
69+
```bash
70+
katta storageprofile minio sts \
71+
--hubUrl <hub-url> \
72+
--endpointUrl <minio-endpoint-url> \
73+
--region <region> \
74+
--stsRoleCreateBucket <role-arn> \
75+
--stsRoleAccessBucket <role-arn>
76+
```
77+
78+
**Required Options:**
79+
80+
- `--hubUrl`: Hub URL. Example: `https://hub.default.katta.cloud/`
81+
- `--endpointUrl`: MinIO endpoint URL (S3 API). Example: `https://minio.example.com` or `https://minio.example.com:9000`
82+
- `--region`: Default bucket region. Example: `us-east-1`
83+
- `--stsRoleCreateBucket`: MinIO role ARN for bucket creation (from `mc idp openid ls` for the `cryptomator` client).
84+
- `--stsRoleAccessBucket`: MinIO role ARN for bucket access (from `mc idp openid ls` for the `cryptomatorvaults` client).
85+
86+
**Additional Options:**
87+
88+
- `--bucketPrefix`: Prefix used when creating buckets for this storage profile. Defaults to `katta-`.
89+
- `--regions`: Additional bucket regions. Example: `--regions us-east-1 --regions us-west-2`
90+
- `--name`: Display name for the storage profile.
91+
- `--uuid`: UUID for the storage profile (auto-generated if omitted).
92+
6093
### Generate shell completion script with `completion` command
6194

6295
Generate a bash completion script for the `katta` CLI and install it for the current shell session.

0 commit comments

Comments
 (0)