Tencent S3 Compatible Support Docs #3115

imjokey · 2020-11-26T12:23:29Z

Add Tencent Cloud S3-Compatible object store providers Support Docs

Signed-off-by: jokeyli <[email protected]>

nrb

Thanks for the documentation @imjokey! This is great! I have a few suggested changes.

changelogs/unreleased/3115-imjokey

site/content/docs/main/contributions/tencent-config.md

a-mccarthy

I went through and added some wording suggestions based on the Velero style guide, https://velero.io/docs/v1.5/style-guide/.

a-mccarthy · 2020-11-30T22:59:31Z

site/content/docs/main/contributions/tencent-config.md

+---
+
+
+You can deploy Velero on Tencent [TKE](https://console.cloud.tencent.com/tke2/) , or even on any other Kubernetes cluster, but anyway you can use Tencent Cloud Object Store as a destination for Velero’s backups.


suggestion: "You can deploy Velero on Tencent TKE, or an other Kubernetes cluster, and use Tencent Cloud Object Store as a destination for Velero’s backups."

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:01:08Z

site/content/docs/main/contributions/tencent-config.md

+
+- Registered [Tencent Cloud Account](https://cloud.tencent.com/register).
+- Tencent Cloud COS service, referred to as COS, has been launched.
+- A Kubernetes cluster has been created, cluster version v1.10 or later, and the cluster can use DNS and Internet services normally. If you need to create a TKE cluster, Please refer to [Create a cluster](https://cloud.tencent.com/document/product/457/32189).


suggestion: "If you need to create a TKE cluster, refer to the Tencent create a cluster documentation."

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:02:30Z

site/content/docs/main/contributions/tencent-config.md

+
+## Create a Tencent cloud COS bucket
+
+Create an object bucket for Velero to store backups in the Tencent Cloud COS console. About how to create a bucket, please refer to Tencent Cloud COS [Create a bucket](https://cloud.tencent.com/document/product/436/13309) usage instructions.


suggestion to replace "About how to create.." with "For how to create..."

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:04:55Z

site/content/docs/main/contributions/tencent-config.md

+
+Create an object bucket for Velero to store backups in the Tencent Cloud COS console. About how to create a bucket, please refer to Tencent Cloud COS [Create a bucket](https://cloud.tencent.com/document/product/436/13309) usage instructions.
+
+Set access to the bucket through the object storage console, the bucket needs to be **read** and **written**, so the account is granted data reading,  data writing permissions, About how to configure See [Permission Access Settings](https://cloud.tencent.com/document/product/436/13315.E5.8D.95.E4.B8.AA.E6.8E.88.E6.9D.83).


"Set access to the bucket through the object storage console, the bucket needs to be read and written, so the account is granted data reading, data writing permissions. For how to configure, see the permission access settings Tencent user instructions."

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:06:36Z

site/content/docs/main/contributions/tencent-config.md

+
+## Get bucket access credentials
+
+Velero uses an AWS S3-compatible API to access Tencent Cloud COS storage, which requires authentication using a pair of access key IDs and key-created signatures, and in the S3 API parameter, the "access_key_id" field is the access key ID and the "secret_access_key" field is the key.


Maybe make this two sentences, "Velero uses an AWS S3-compatible API to access Tencent Cloud COS storage, which requires authentication using a pair of access key IDs and key-created signatures. In the S3 API parameter, the "access_key_id" field is the access key ID and the "secret_access_key" field is the key. "

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:28:19Z

site/content/docs/main/contributions/tencent-config.md

+
+{{< figure src="https://main.qcloudimg.com/raw/e932223585c0b19891cc085ad7f438e1.png" width="100%">}}
+
+With Velero Backup, you can back up all objects in the cluster directly, or filter objects by type, namespace, and/or label, and in this example I use the following command to back up only all resources under the 'default' namespace:


Suggestion - "With Velero Backup, you can back up all objects in the cluster directly, or filter objects by type, namespace, and/or label. This example uses the following command to back up all resources under the 'default' namespace."

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:32:04Z

site/content/docs/main/contributions/tencent-config.md

+{{< figure src="https://main.qcloudimg.com/raw/eb2bbabae48b188748f5278bedf177f1.png" width="100%">}}
+
+
+At this point we delete all of minio's resources, including its PVC persistence volume, as shown below:


suggestion - "At this point delete all of MinIO's resources, including its PVC persistence volume, as shown below:"

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:36:18Z

site/content/docs/main/contributions/tencent-config.md

+
+{{< figure src="https://main.qcloudimg.com/raw/15ccaacf00640a04ae29ceed4c86195b.png" width="100%">}}
+
+After deleting the minio resource, we can test using the previous backup to restore the deleted minio resource, and temporarily update the backup storage location to read-only mode (this prevents the backup object from being created or deleted in the backup storage location during the restore process):


suggestion - "After deleting the MinIO resource, use your backup to restore the deleted MinIO resource, and temporarily update the backup storage location to read-only mode (this prevents the backup object from being created or deleted in the backup storage location during the restore process):"

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:40:26Z

site/content/docs/main/contributions/tencent-config.md

+
+```
+
+Modifying access to velero's storage location is "ReadOnly," as shown in the following image:


need to capitalize Velero here

thank u, I will fixed it.

a-mccarthy · 2020-11-30T23:52:10Z

site/content/docs/main/contributions/tencent-config.md

+
+In the cluster, use the helm tool to create a minio test service with a persistent volume, and the minio installation method can be found in the [minio installation](https://github.com/minio/charts), in which case I have bound a load balancer for the minio service to access the management page using a public address in the browser.
+
+{{< figure src="https://main.qcloudimg.com/raw/f0fff5228527edc72d6e71a50d5dc966.png" width="100%">}}


Can you add these images to the velero repo?

Thank you, but I have the following confusion:

Which directory should I put the picture in? /docs/main/img?

Since I need to customize the width of the picture, I use figure shortcodde, the local link makes it impossible for me to get to src. I don't know how to fix it.

I have been solved the second confusion，thank u very much.

I also create a directory "contributions/img-for-tencent" for put the images to solve the first confusion.

Signed-off-by: jokeyli <[email protected]>

carlisia

This lgtm 👍

We are getting some CHMOD warnings from the Hugo server output, I'm investigating.

carlisia · 2020-12-11T17:53:16Z

Weird. I was getting one of these for each of the new images:

INFO 2020/12/11 09:41:16 Received System Events: ["/Users/carlisiac/work/src/github.com/vmware-tanzu/velero/site/content/docs/v1.5/contributions/img-for-tencent/15ccaacf00640a04ae29ceed4c86195b.png": CHMOD

but moved some stuff around and these messages stopped.

carlisia

lgtm 👍

* Tencent S3 Compatible Surpport Docs Signed-off-by: jokeyli <[email protected]> * fixed typos & and CHANGELOG log Signed-off-by: jokeyli <[email protected]> * add changelog Signed-off-by: jokeyli <[email protected]> * add changelog Signed-off-by: jokeyli <[email protected]> * fixed suggestions Signed-off-by: jokeyli <[email protected]>

github-actions bot requested review from ashish-amarnath, carlisia, dsu-igeek, nrb and zubron November 26, 2020 12:23

github-actions bot assigned imjokey Nov 26, 2020

Tencent S3 Compatible Surpport Docs

22cc9d9

Signed-off-by: jokeyli <[email protected]>

imjokey force-pushed the s3-compatible-docs branch from 25748d3 to 22cc9d9 Compare November 26, 2020 12:26

fixed typos & and CHANGELOG log

ceb8f23

Signed-off-by: jokeyli <[email protected]>

imjokey force-pushed the s3-compatible-docs branch from 673ad5f to ceb8f23 Compare November 26, 2020 12:53

imjokey added 2 commits November 26, 2020 21:00

add changelog

efce68e

Signed-off-by: jokeyli <[email protected]>

add changelog

ef0abc5

Signed-off-by: jokeyli <[email protected]>

nrb added the Area/Documentation label Nov 30, 2020

nrb suggested changes Nov 30, 2020

View reviewed changes

changelogs/unreleased/3115-imjokey Outdated Show resolved Hide resolved

site/content/docs/main/contributions/tencent-config.md Outdated Show resolved Hide resolved

nrb requested a review from a-mccarthy November 30, 2020 19:28

a-mccarthy suggested changes Nov 30, 2020

View reviewed changes

github-actions bot requested a review from nrb December 1, 2020 06:40

imjokey force-pushed the s3-compatible-docs branch from f5b4d3f to 5194ea2 Compare December 1, 2020 06:51

fixed suggestions

62544f2

Signed-off-by: jokeyli <[email protected]>

imjokey force-pushed the s3-compatible-docs branch from 5194ea2 to 62544f2 Compare December 1, 2020 06:54

imjokey requested a review from a-mccarthy December 9, 2020 13:04

carlisia previously approved these changes Dec 11, 2020

View reviewed changes

carlisia approved these changes Dec 11, 2020

View reviewed changes

nrb changed the title ~~Tencent S3 Compatible Surpport Docs~~ Tencent S3 Compatible Support Docs Dec 11, 2020

nrb approved these changes Dec 11, 2020

View reviewed changes

a-mccarthy approved these changes Dec 11, 2020

View reviewed changes

nrb merged commit 2f635e1 into vmware-tanzu:main Dec 11, 2020

georgettica mentioned this pull request Dec 23, 2020

georgettica/bump external snapshotter version #3201

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tencent S3 Compatible Support Docs #3115

Tencent S3 Compatible Support Docs #3115

imjokey commented Nov 26, 2020

nrb left a comment

a-mccarthy left a comment

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

a-mccarthy Nov 30, 2020

imjokey Dec 1, 2020

imjokey Dec 1, 2020

imjokey Dec 1, 2020

carlisia left a comment

carlisia commented Dec 11, 2020

carlisia left a comment

		---


		You can deploy Velero on Tencent [TKE](https://console.cloud.tencent.com/tke2/) , or even on any other Kubernetes cluster, but anyway you can use Tencent Cloud Object Store as a destination for Velero’s backups.


		## Create a Tencent cloud COS bucket

		Create an object bucket for Velero to store backups in the Tencent Cloud COS console. About how to create a bucket, please refer to Tencent Cloud COS [Create a bucket](https://cloud.tencent.com/document/product/436/13309) usage instructions.


		Create an object bucket for Velero to store backups in the Tencent Cloud COS console. About how to create a bucket, please refer to Tencent Cloud COS [Create a bucket](https://cloud.tencent.com/document/product/436/13309) usage instructions.

		Set access to the bucket through the object storage console, the bucket needs to be read and written, so the account is granted data reading, data writing permissions, About how to configure See [Permission Access Settings](https://cloud.tencent.com/document/product/436/13315.E5.8D.95.E4.B8.AA.E6.8E.88.E6.9D.83).


		## Get bucket access credentials

		Velero uses an AWS S3-compatible API to access Tencent Cloud COS storage, which requires authentication using a pair of access key IDs and key-created signatures, and in the S3 API parameter, the "access_key_id" field is the access key ID and the "secret_access_key" field is the key.


		{{< figure src="https://main.qcloudimg.com/raw/e932223585c0b19891cc085ad7f438e1.png" width="100%">}}

		With Velero Backup, you can back up all objects in the cluster directly, or filter objects by type, namespace, and/or label, and in this example I use the following command to back up only all resources under the 'default' namespace:

		{{< figure src="https://main.qcloudimg.com/raw/eb2bbabae48b188748f5278bedf177f1.png" width="100%">}}


		At this point we delete all of minio's resources, including its PVC persistence volume, as shown below:


		{{< figure src="https://main.qcloudimg.com/raw/15ccaacf00640a04ae29ceed4c86195b.png" width="100%">}}

		After deleting the minio resource, we can test using the previous backup to restore the deleted minio resource, and temporarily update the backup storage location to read-only mode (this prevents the backup object from being created or deleted in the backup storage location during the restore process):


		```

		Modifying access to velero's storage location is "ReadOnly," as shown in the following image:


		In the cluster, use the helm tool to create a minio test service with a persistent volume, and the minio installation method can be found in the [minio installation](https://github.com/minio/charts), in which case I have bound a load balancer for the minio service to access the management page using a public address in the browser.

		{{< figure src="https://main.qcloudimg.com/raw/f0fff5228527edc72d6e71a50d5dc966.png" width="100%">}}

Tencent S3 Compatible Support Docs #3115

Tencent S3 Compatible Support Docs #3115

Conversation

imjokey commented Nov 26, 2020

nrb left a comment

Choose a reason for hiding this comment

a-mccarthy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlisia left a comment

Choose a reason for hiding this comment

carlisia commented Dec 11, 2020

carlisia left a comment

Choose a reason for hiding this comment