Add documentation for COS as storage #8
Conversation
| @@ -333,3 +333,54 @@ storage_config: | |||
| kms_key_id: 0987dcba-09fe-87dc-65ba-ab0987654321 | |||
| ``` | |||
|
|
|||
There was a problem hiding this comment.
maybe another empty line for consistency.
|
|
||
| When using IBM Cloud Object Storage (COS) as object storage, the following permissions are needed: | ||
|
|
||
| - `Content Reader` |
There was a problem hiding this comment.
so far, we requested for Writer and Content Reader, that should be sufficient.
Writer permissions should be sufficient.
|
|
||
| storage_config: | ||
| cos: | ||
| bucket: <bucket> |
There was a problem hiding this comment.
We need to fix the bucket field name.bucket vs bucketnames.
There was a problem hiding this comment.
We discussed and agreed to be consistent with s3 and keep bucketnames.
|
|
||
| storage_config: | ||
| cos: | ||
| bucket: <bucket> |
There was a problem hiding this comment.
Here as well, we need to fix the bucket field name.bucket vs bucketnames.
| @@ -109,6 +110,14 @@ Resources: `*` | |||
| Resources: `arn:aws:iam::<aws_account_id>:role/<role_name>` | |||
|
|
|||
|
|
|||
| ### IBM Cloud Object Storage | |||
|
|
|||
| When using IBM Cloud Object Storage (COS) as object storage, the following permissions are needed: | |||
There was a problem hiding this comment.
since it is one permission, let's rephrase this statement:
When using IBM Cloud Object Storage (COS) as object storage, IAM
Writerrole is needed.
| @@ -42,6 +42,9 @@ S3 is AWS's hosted object store. It is a good candidate for a managed object sto | |||
| Blob Storage is Microsoft Azure's hosted object store. It is a good candidate for a managed object store, especially when you're already running on Azure, and is production safe. | |||
| You can authenticate Blob Storage access by using a storage account name and key or by using a Service Principal. | |||
|
|
|||
| ### IBM Cloud Object Storage (COS) | |||
There was a problem hiding this comment.
maybe a link to IBM Cloud Object Storage landing page?
There was a problem hiding this comment.
We felt is wiered to add link in the header, so we added cos landing page link in description.
docs/sources/storage/_index.md
Outdated
|
|
||
| storage_config: | ||
| cos: | ||
| bucket: <bucket> |
There was a problem hiding this comment.
We need to fix the bucket field name.bucket vs bucketnames.
docs/sources/storage/_index.md
Outdated
| auth_endpoint: <iam_endpoint_for_authentication> | ||
| ``` | ||
|
|
||
| The role should have a policy with the following permissions attached. |
There was a problem hiding this comment.
IMO, it is sufficient to indicate that the IAM Writer role is needed, let's avoid such details which might confuse people.
There was a problem hiding this comment.
If they want to have more advanced access, they should refer to IAM.
There was a problem hiding this comment.
Removed the policy json
* Add documentation for COS as storage * Address review comments
* cos client creation code and unit tests * Added GetObject,PutObject and IsObjectNotFoundErr code and unit tests Co-authored-by: Suruthi-G-K <[email protected]> * add ListObject and DeleteObject methods and unit tests Rebasing the code Update config and test files with new changes Update unit test for List Arrange methods belong to mockCosClient together Updated test cases to run independently Co-authored-by: tareqmamari <[email protected]> * add support for IAM API Key Authentication Added code to support IAM API Key Authentication Update the conditions for api key use default auth endpoint for cos Use default auth endpoint instead of forcing to pass auth endpoint always for COS storage provider. Replace const to defaultCOSAuthEndpoint Replace DEFAULT_COS_AUTH_ENDPOINT with defaultCOSAuthEndpoint Also fixed error fmt.Errorf call needs 6 args but has 7 args Added new cases in Test_COSConfig Added unit test for IAM API Key Authentication iam api key auth test formatting These are just minor formatting changes for IAM API key authentication tests. lowercase clifags cos prefix and rename to hedgedCOS Co-authored-by: tareqmamari <[email protected]> Co-authored-by: amankrsingh2000 <[email protected]> * add documentation for COS storage (#8) * Add documentation for COS as storage * Address review comments --------- Co-authored-by: Aman Kumar Singh <[email protected]> Co-authored-by: Suruthi-G-K <[email protected]> Co-authored-by: “athira <[email protected]> Co-authored-by: tareqmamari <[email protected]> Co-authored-by: “athira <[email protected]> Co-authored-by: Shahul <[email protected]>
* Add documentation for COS as storage * Address review comments
* Add documentation for COS as storage * Address review comments
* Add documentation for COS as storage * Address review comments
Loki COS Integration: Update Loki documentation