-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Victor Vorobyev
committed
Dec 6, 2023
1 parent
18e1f33
commit 2788644
Showing
4 changed files
with
100 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
title: Amazon S3 Object Tagging | ||
weight: 18 | ||
description: Cloudback supports S3 Object Tagging feature for your backups. | ||
keywords: github backup, cloudback, amazon s3 object tag, s3 object tag, object tag, tag, amazon s3, s3, aws s3, s3 bucket, s3 storage, s3 object tag feature | ||
--- | ||
|
||
# Amazon S3 Object Tagging | ||
|
||
[Amazon S3 Object Tagging](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) is a feature provided by Amazon Web Services in their Simple Storage Service. It's designed to help you to categorize your storage. Cloudback supports S3 Object Tagging feature using custom HTTP headers for the the [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) API call. | ||
|
||
## Getting Started | ||
|
||
### HTTP headers for S3 Object Tagging | ||
|
||
#### x-amz-tagging | ||
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1"). | ||
|
||
Example: | ||
``` | ||
x-amz-tagging: Key1=Value1&Key2=Value2 | ||
``` | ||
|
||
### Build-in variables | ||
|
||
You can use the following variables in the `x-amz-tagging` header: | ||
|
||
- `{{ context.RepositoryName }}`: The name of the repository that is being backed up. | ||
- `{{ context.AccountName }}`: The name of the owner account of the repository that is being backed up. | ||
|
||
Example: | ||
``` | ||
x-amz-tagging: RepositoryName={{ context.RepositoryName }}&AccountName={{ context.AccountName }} | ||
``` | ||
|
||
### Storage wizard | ||
|
||
Additional HTTP headers are supported for all S3 compatible storages: | ||
|
||
- Amazon S3 Bucket: Access Point | ||
- Amazon S3 Bucket: Access Key | ||
- OpenStack Swift Container: S3 API | ||
- Wasabi S3 Bucket: Access Key | ||
|
||
Example `Storage Wizard` screenshot: | ||
|
||
![Headers](/static/features/s3-custom-headers.png) | ||
|
||
## Learn more | ||
- External Article: [Categorizing your storage using tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) | ||
- External Article: [PutObject Request Syntax](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html#API_PutObject_RequestSyntax) | ||
- [Amazon S3 Object Lock](/features/s3-object-lock/) | ||
- [Customer Managed Storages](/features/customer-storages/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
title: Known Issues | ||
linkTitle: Known Issues | ||
weight: 16 | ||
description: The list of Cloudback known issues | ||
keywords: github backup, cloudback, known issues, issues | ||
--- | ||
|
||
# Cloudback Known Issues | ||
|
||
## 'It is required to install out GitHub Application' error occurs right after changing the organization member role to 'Owner' | ||
|
||
Prerequisites: | ||
- You have a GitHub organization with at least one non-owner member. | ||
- You have a GitHub Cloudback application installed in your organization. | ||
- Cloudback Dashboard is accessible for the organization owners only. | ||
|
||
Steps to reproduce: | ||
- Change the organization member role to 'Owner'. | ||
- Open the Cloudback Dashboard. | ||
|
||
Expected result: | ||
- The Cloudback Dashboard is accessible. | ||
|
||
Actual result: | ||
- The 'It is required to install out GitHub Application' error occurs. | ||
|
||
<p align="center"> | ||
<img src="https://github.com/cloudback/docs/blob/master/static/issue1.png?raw=true" alt="It is required to install out GitHub Application error" class="screenshot"> | ||
</p> | ||
|
||
Root cause: | ||
- GitHub does not send any notification of a role change of the organization member to the GitHub application. Cloudback uses cached data. It is a known issue, confirmed by GitHub Support Team. | ||
|
||
Workaround: | ||
- Remove the member from the organization. | ||
- Re-add the member to the organization with Owner role. | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.