scylladb / scylladb-cloud-doc-issues

A repo for Scylla Cloud docs issues
https://cloud.docs.scylladb.com/stable/
1 stars 1 forks source link

docs: Issue in page Configure AWS Transit Gateway (TGW) VPC Attachment Connection #16

Open scylladb-buff opened 6 months ago

scylladb-buff commented 6 months ago

I would like to report an issue in page https://cloud.docs.scylladb.com/master/cluster-connections/aws-tgw-vpc-attachment CC: @mixellent

Problem

The following section is misleading you cannot deploy TGW in ScyllaDB Cloud account but description of Cluster AWS Account explicitly says it can be bot customer own and Scylla Cloud account: "If you have access to a Cluster AWS Account, you can create a TGW on the same region where the cluster is running, and this TGW becomes available to the cluster - no need to share it via RAM.

Suggest a fix

If the ScyllaDB cluster is deployed in your AWS Account, you can provision a TGW on the same region where the cluster is running, and this TGW becomes available to the cluster - no need to share it via RAM. If the cluster is in ScyllaDB Cloud TGW should be shared via RAM.

mixellent commented 6 months ago

Makes sense and looks good to me.

annastuchlik commented 5 months ago

@scylladb-buff @mixellent I'll make the update.

However, this means that the definigion of Cluster AWS Account in Glossary is wrong, as it says:

AWS account where cluster is running, could be ScyllaDB Cloud AWS Account ( 696340704738 ), or could be customer AWS account.

Should we have the following definitions?

ScyllaDB Cloud AWS Account AWS account where ScyllaDB Cloud is running your clusters ( 696340704738 ).

Cluster AWS Account Your AWS account where your cluster is running.

cc @dkropachev

dkropachev commented 5 months ago

I would suggest minor update:

If the ScyllaDB cluster is deployed in your AWS Account, you can provision a TGW on the same region where the cluster is running, and this TGW becomes available to the cluster - no need to share it via RAM. If the cluster is in ScyllaDB Cloud AWS Account TGW should be created on your account and shared via RAM.

@scylladb-buff , WDYT?

dkropachev commented 5 months ago

@scylladb-buff @mixellent I'll make the update.

However, this means that the definigion of Cluster AWS Account in Glossary is wrong, as it says:

AWS account where cluster is running, could be ScyllaDB Cloud AWS Account ( 696340704738 ), or could be customer AWS account.

Should we have the following definitions?

ScyllaDB Cloud AWS Account AWS account where ScyllaDB Cloud is running your clusters ( 696340704738 ).

Cluster AWS Account Your AWS account where your cluster is running.

cc @dkropachev

@annastuchlik , still a bit confusing, WDYT of the following:

ScyllaDB Cloud AWS Account AWS account ( 696340704738 ) that belongs to ScyllaDB Inc. and is used to run clusters on as default option

Cluster AWS Account Your AWS account that is delegated to ScyllaDB to run your clusters on.

scylladb-buff commented 5 months ago

Thanks for your comments, they are both valid, but the message was still confusing.

Customer AWS refers not only to the account customers use to deploy databases on. It is also the account network components are deployed on. In addition, the whole paragraph had to be reworded to start with the default use case when the cluster is deployed in Scylla Cloud (without BYOK) So I had to reword both:

-- ScyllaDB AWS Account

AWS account where the ScyllaDB database cluster is deployed. In most cases, this is the ScyllaDB Cloud's AWS Account ( 696340704738 ).

Customer AWS Account

An AWS account under customer control. This account is used by customers to deploy network components, applications, or other components. ScyllaDB offers the option to deploy ScyllaDB Clusters on a customer AWS Account (Link to BYOA documentation)

--

If your database is created on ScyllaDB Cloud it will be deployed in [ScyllaDB AWS Account] (https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-ScyllaDB AWS Account) you should create the Transit Gateway in [your AWS Account](https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-Customer AWS Account). To connect to this gateway, you have to share it via RAM.

Alternatively, if your ScyllaDB cluster is deployed in [your AWS Account](https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-Customer AWS Account) by using BYOA feature, you have the option to provision a Transit Gateway in the same region where the ScyllaDB cluster is deployed. The gateway will become available to the cluster, without the need to share it via RAM.

WDYT?

dkropachev commented 5 months ago

-- ScyllaDB AWS Account

AWS account where the ScyllaDB database cluster is deployed. In most cases, this is the ScyllaDB Cloud's AWS Account ( 696340704738 ).

What confuses me is that first part AWS account where the ScyllaDB database cluster is deployed is practically matches any account where ScyllaDB is deployed. Also in ScyllaDB database cluster word database is redundant

Customer AWS Account

An AWS account under customer control. This account is used by customers to deploy network components, applications, or other components.

It might trick customer to think that it needs to deploy network components to make cluster work. Also this account could be used solely to host ScyllaDB clusters, which invalidates This account is used by customers to deploy network components, applications, or other components.

--

If your database is created on ScyllaDB Cloud it will be deployed in [ScyllaDB AWS Account] (https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-ScyllaDB AWS Account) you should create the Transit Gateway in [your AWS Account](https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-Customer AWS Account). To connect to this gateway, you have to share it via RAM.

If your cluster is created on ScyllaDB Cloud it will be deployed in [ScyllaDB AWS Account] (https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-ScyllaDB AWS Account) you should create the Transit Gateway in [your AWS Account](https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-Customer AWS Account). To connect to this gateway, you have to share it via RAM.

Alternatively, if your ScyllaDB cluster is deployed in [your AWS Account](https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-Customer AWS Account) by using BYOA feature, you have the option to provision a Transit Gateway in the same region where the ScyllaDB cluster is deployed. The gateway will become available to the cluster, without the need to share it via RAM.

Alternatively, if your ScyllaDB cluster is deployed in [your AWS Account](https://cloud.docs.scylladb.com/master/cluster-connections/glossary-cluster-connection.html#term-Customer AWS Account) by using BYOA feature, you have the option to provision a Transit Gateway in the same account and region where the ScyllaDB cluster is deployed. The gateway will become available to the cluster, without the need to share it via RAM.

scylladb-buff commented 5 months ago

Valid comments @dkropachev, it can be worded clearer. I would leave wording and the user perception to @annastuchlik.

annastuchlik commented 5 months ago

I'll open a PR with a proposal.

We can continue the discussion directly in the PR.