Commit 4d9bf42
docs: add missing policy attachment step for object storage (#637)
* docs: add missing policy attachment step for object storage
Add documentation for attaching user access policies to object storage
users, which is required for bucket access via AWS CLI and S3-compatible
tools.
The documentation now includes:
1. API-based policy attachment using curl with token authentication
2. Web console-based policy attachment
3. Important note about permission requirements
Fixes #570
* docs: add missing policy attachment step for object storage
Add complete end-to-end documentation for object storage access
including the critical policy attachment step that was missing.
Changes:
- Add policy attachment via UpCloud API (tested, returns HTTP 204)
- Add policy attachment via web console alternative
- Add S3 access verification example with AWS CLI
- Clarify credential usage (UpCloud API token vs S3 access keys)
- Include note about saving S3 access key credentials
Without the policy attachment step, users cannot access buckets
via S3-compatible tools even with valid S3 access keys.
Tested end-to-end workflow:
- Service and bucket creation ✓
- User and S3 access key creation ✓
- Policy attachment via API ✓ (HTTP 204 success)
- Documentation includes S3 access verification
Fixes #570
* Apply suggestions from code review
Mark example using `aws` command as not to be tested, since command is missing on CI.
Co-authored-by: Toni Kangas <kangasta@users.noreply.github.com>
* docs: parse dynamic values for object storage example testing
Address review feedback from paketeserrano on PR #637 to enable
automated testing in .github/workflows/examples.yaml:
- Parse service UUID dynamically from `upctl object-storage list`
- Capture access key credentials from JSON output
- Extract service endpoint from `upctl object-storage show`
- Replace placeholder values with actual parsed variables
This allows the documentation to function as an automated test
in the CI/CD workflow without manual value substitution.
The documentation remains readable while being executable.
* docs: skip curl policy attachment in CI tests
The curl command for policy attachment requires UPCLOUD_TOKEN (bearer token)
but CI only provides UPCLOUD_USERNAME/PASSWORD. Mark the curl block with
when=false to skip during mdtest execution.
This fixes the exit code 102 failure in the Examples workflow. The policy
attachment is still documented for manual use and the alternative web
console method is provided.
Added explanatory comment about why this is skipped in tests.
* chore: remove user deletion
---------
Co-authored-by: Toni Kangas <kangasta@users.noreply.github.com>
Co-authored-by: Francisco Serrano <59340762+paketeserrano@users.noreply.github.com>
Co-authored-by: Francisco Serrano <francisco.serrano@upcloud.com>1 parent 37677a0 commit 4d9bf42
1 file changed
+44
-6
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
36 | 40 | | |
37 | 41 | | |
38 | | - | |
| 42 | + | |
39 | 43 | | |
40 | | - | |
41 | | - | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
42 | 80 | | |
43 | 81 | | |
44 | | - | |
| 82 | + | |
45 | 83 | | |
46 | 84 | | |
47 | 85 | | |
48 | | - | |
| 86 | + | |
0 commit comments