本記事では、OceanBase CloudにおけるBYOCシナリオでのクラウドアカウントの権限付与の手順を説明します。現在、AWSをサポートしています。
前提条件
利用可能なOceanBase Cloudアカウントを所有し、対象プロジェクトの管理権限(プロジェクト所有者またはプロジェクト管理者)を持っていること。
利用可能なAWSアカウントを所有し、AWS管理コンソールにアクセスできること。
現在のプロジェクトをBYOCプロジェクトに切り替えること。
オブジェクトストレージバケットの作成が完了していること。詳細については、Amazon S3コンソールを参照してください。
手順
OceanBase CloudのBYOCコンソールにログインし、上部メニューバーで対象のBYOCプロジェクトに切り替えます。
左側のナビゲーションバーで プロジェクト設定 をクリックし、プロジェクト設定ページで BYOCクラウドアカウントの権限付与 をクリックします。
クラウドアカウントの権限付与を作成する をクリックし、クラウドアカウント権限付与名 を入力します。名前は任意ですが、長さは2文字以上64文字以下である必要があり、数字、英字、アンダースコア、ハイフンのみを含めることができます。
権限を付与するクラウドサービスプロバイダーで AWS を選択し、AWSの指示に従って後続の設定を完了します。詳細については、以下のAWSの権限付与設定を参照してください。
AWSの権限付与設定
注意
AWSを基盤クラウド環境として選択する場合は、対象のアカウントおよびリージョンで、NLBターゲットグループのProxy Protocol v2の設定 proxy_protocol_v2.client_to_server.header_placement=on_first_ack を有効にするよう、事前にAWSテクニカルサポートに依頼してください。この設定はMySQLなどのプロトコル向けで、バックエンドとの接続が確立すると直ちにヘッダーを送信します。このプロパティの有効化はアカウントとリージョンの組み合わせごとに行うため、必要なリージョンを事前に評価し、一括して有効にすることを推奨します。そうでない場合、テナント作成後に接続アドレスからデータベースにアクセスできない可能性があります。
AWSコンソールで、OceanBase Cloudのアカウント間アクセスに使用するIAMロールを作成します。
AWS管理コンソールにログインし、IAM > ロールページでロールの作成をクリックします。
信頼されたエンティティタイプの選択で、AWSアカウントを選択し、別のAWSアカウントを選択します。
アカウントIDに、OceanBase Cloudの権限付与ポップアップで提供されたメインアカウントIDを入力します。
外部IDが必要を選択し、OceanBase Cloudの権限付与ポップアップで提供された外部ID(External ID)を入力します。
権限の追加ステップで、インラインポリシーの作成を選択し、OceanBase Cloudの権限付与ポップアップで提供されたポリシーJSONをポリシー編集ボックスに貼り付けます。ポリシーにオブジェクトストレージバケットなどのプレースホルダーが含まれている場合は、バックアップ用のS3ストレージバケット名など、実際のリソース情報に置き換えてください。ポリシーの内容例およびプレースホルダーの説明については、以下の権限ポリシーと信頼ポリシーを参照してください。
プロンプトに従ってロールに名前を付け、作成を完了します。
説明
OceanBase Cloudが提供するポリシーは、BYOCシナリオで必要な最小権限セットです。重要な権限項目を削除しないでください。削除すると、後の作成や運用に失敗する可能性があります。
権限付与の検証:
ロールの詳細ページに移動し、そのARN(Role ARN)をコピーします。
OceanBase Cloudの権限付与ポップアップに戻り、Role ARNをARN入力ボックスに貼り付けます。
確認 をクリックして、権限付与を完了します。
権限ポリシーと信頼ポリシー
OceanBase Cloudで必要な長いポリシーを設定できるようにするため、カスタマーマネージドポリシー(customer managed policy)ではなく、インラインポリシー(inline policy)の使用を推奨します。インラインポリシーの文字数上限は10,240文字、カスタマーマネージドポリシーは6,144文字です。また、ロールを削除するだけでポリシー内容も自動的に削除されるため、手間がかかりません。
権限ポリシー:ロール作成時の権限の追加ステップで、インラインポリシーとして貼り付けます。貼り付ける前に、<CUSTOMER_AWS_ACCOUNT_ID>をご自身のAWSアカウントIDに、<BYOC_BUCKET_NAME>をOceanBase Cloudに開放するS3バケット名に置き換えてください。
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "OceanBaseActionsWithoutTagCondition",
"Effect": "Allow",
"Action": [
"ec2:DescribeAddresses",
"ec2:DescribeAvailabilityZones",
"ec2:DescribeIamInstanceProfileAssociations",
"ec2:DescribeImages",
"ec2:DescribeInternetGateways",
"ec2:DescribeInstanceAttribute",
"ec2:DescribeInstanceTypeOfferings",
"ec2:DescribeInstanceTypes",
"ec2:DescribeInstances",
"ec2:DescribeNatGateways",
"ec2:DescribeNetworkInterfaces",
"ec2:DescribePlacementGroups",
"ec2:DescribeReplaceRootVolumeTasks",
"ec2:DescribeRouteTables",
"ec2:DescribeSecurityGroupRules",
"ec2:DescribeSecurityGroups",
"ec2:DescribeSubnets",
"ec2:DescribeVolumes",
"ec2:DescribeVpcEndpointConnections",
"ec2:DescribeVpcEndpointServiceConfigurations",
"ec2:DescribeVpcEndpointServicePermissions",
"ec2:DescribeVpcPeeringConnections",
"ec2:DescribeVpcs",
"ec2:GetInstanceTypesFromInstanceRequirements",
"ec2:AllocateAddress",
"ec2:AuthorizeSecurityGroupEgress",
"ec2:AuthorizeSecurityGroupIngress",
"ec2:AttachInternetGateway",
"ec2:CreateInternetGateway",
"ec2:CreateLaunchTemplate",
"ec2:CreateNatGateway",
"ec2:CreatePlacementGroup",
"ec2:DeletePlacementGroup",
"ec2:CreateRoute",
"ec2:DeleteRoute",
"ec2:CreateRouteTable",
"ec2:CreateSecurityGroup",
"ec2:CreateSubnet",
"ec2:CreateVolume",
"ec2:CreateVpc",
"ec2:CreateVpcEndpointServiceConfiguration",
"ec2:CreateVpcPeeringConnection",
"ec2:RunInstances",
"ec2:CreateNetworkInterface",
"elasticloadbalancing:DescribeListeners",
"elasticloadbalancing:DescribeLoadBalancerAttributes",
"elasticloadbalancing:DescribeLoadBalancers",
"elasticloadbalancing:DescribeTags",
"elasticloadbalancing:DescribeTargetGroups",
"elasticloadbalancing:DescribeTargetHealth",
"elasticloadbalancing:CreateListener",
"elasticloadbalancing:CreateLoadBalancer",
"elasticloadbalancing:CreateTargetGroup",
"eks:DescribeCluster",
"eks:DescribeNodegroup",
"eks:ListClusters",
"eks:ListNodegroups",
"eks:CreateCluster",
"eks:CreateNodegroup",
"eks:DescribeAddon",
"eks:CreateAddon",
"eks:UpdateAddon",
"eks:DescribePodIdentityAssociation",
"elasticfilesystem:DescribeFileSystems",
"elasticfilesystem:DescribeMountTargets",
"elasticfilesystem:CreateFileSystem",
"ecr:DescribeImages",
"ecr:DescribeRepositories",
"ecr:ListImages",
"iam:ListPolicies",
"ssm:DescribeInstanceInformation",
"ssm:GetCommandInvocation",
"ssm:ListCommandInvocations",
"route53:AssociateVPCWithHostedZone",
"route53:ChangeResourceRecordSets",
"route53:ChangeTagsForResource",
"route53:CreateHostedZone",
"route53:DeleteHostedZone",
"route53:GetHostedZone",
"route53:ListHostedZones",
"route53:ListResourceRecordSets",
"cloudwatch:GetMetricData",
"autoscaling:DescribeAutoScalingGroups"
],
"Resource": "*"
},
{
"Sid": "OceanBaseActionsOnTaggedResources",
"Effect": "Allow",
"Action": [
"autoscaling:DetachInstances",
"ec2:AcceptVpcEndpointConnections",
"ec2:AcceptVpcPeeringConnection",
"ec2:AssociateIamInstanceProfile",
"ec2:AssociateNatGatewayAddress",
"ec2:AssociateRouteTable",
"ec2:AttachVolume",
"ec2:CreateReplaceRootVolumeTask",
"ec2:DeleteNatGateway",
"ec2:DeleteSecurityGroup",
"ec2:DeleteSubnet",
"ec2:DeleteVolume",
"ec2:DeleteVpc",
"ec2:DeleteVpcEndpointServiceConfigurations",
"ec2:DeleteVpcPeeringConnection",
"ec2:DetachVolume",
"ec2:DisassociateNatGatewayAddress",
"ec2:DisassociateRouteTable",
"ec2:ModifyInstanceAttribute",
"ec2:ModifyVolume",
"ec2:ModifyVpcAttribute",
"ec2:ModifyVpcEndpointServiceConfiguration",
"ec2:ModifyVpcEndpointServicePermissions",
"ec2:RebootInstances",
"ec2:RejectVpcEndpointConnections",
"ec2:ReleaseAddress",
"ec2:ReplaceIamInstanceProfileAssociation",
"ec2:StartInstances",
"ec2:StartVpcEndpointServicePrivateDnsVerification",
"ec2:StopInstances",
"ec2:TerminateInstances",
"elasticloadbalancing:DeleteListener",
"elasticloadbalancing:DeleteLoadBalancer",
"elasticloadbalancing:DeleteTargetGroup",
"elasticloadbalancing:DeregisterTargets",
"elasticloadbalancing:ModifyLoadBalancerAttributes",
"elasticloadbalancing:ModifyTargetGroupAttributes",
"elasticloadbalancing:RegisterTargets",
"elasticloadbalancing:SetSubnets",
"eks:DeleteCluster",
"eks:DeleteNodegroup",
"eks:ListPodIdentityAssociations",
"eks:CreatePodIdentityAssociation",
"eks:UpdateNodegroupConfig",
"elasticfilesystem:CreateMountTarget",
"elasticfilesystem:DeleteFileSystem",
"elasticfilesystem:DeleteMountTarget"
],
"Resource": "*",
"Condition": {
"StringEquals": {
"aws:ResourceTag/ob.sys.cloud_pattern": "byoc"
}
}
},
{
"Sid": "OceanBaseTagOperations",
"Effect": "Allow",
"Action": [
"ec2:CreateTags",
"ec2:DeleteTags",
"elasticloadbalancing:AddTags",
"elasticloadbalancing:RemoveTags",
"eks:TagResource",
"eks:UntagResource",
"elasticfilesystem:TagResource",
"elasticfilesystem:UntagResource",
"autoscaling:CreateOrUpdateTags",
"autoscaling:DeleteTags",
"tag:GetResources",
"tag:TagResources",
"tag:UntagResources"
],
"Resource": "*"
},
{
"Sid": "OceanBaseSendSsmDocuments",
"Effect": "Allow",
"Action": "ssm:SendCommand",
"Resource": [
"arn:aws:ssm:*::document/*",
"arn:aws:ssm:*:*:document/*"
]
},
{
"Sid": "OceanBaseSendCommandToTaggedInstances",
"Effect": "Allow",
"Action": "ssm:SendCommand",
"Resource": "arn:aws:ec2:*:*:instance/*",
"Condition": {
"StringEquals": {
"ssm:resourceTag/ob.sys.cloud_pattern": "byoc"
}
}
},
{
"Sid": "OceanBaseReadIamRolesAndInstanceProfiles",
"Effect": "Allow",
"Action": [
"iam:GetRole",
"iam:ListAttachedRolePolicies",
"iam:ListInstanceProfilesForRole",
"iam:GetInstanceProfile"
],
"Resource": [
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/*",
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:instance-profile/*"
]
},
{
"Sid": "OceanBasePassRolesToRequiredServices",
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": "*",
"Condition": {
"StringEquals": {
"iam:PassedToService": [
"ec2.amazonaws.com",
"eks.amazonaws.com"
]
}
}
},
{
"Sid": "OceanBaseCreateRequiredServiceLinkedRoles",
"Effect": "Allow",
"Action": "iam:CreateServiceLinkedRole",
"Resource": "*",
"Condition": {
"StringEquals": {
"iam:AWSServiceName": [
"eks.amazonaws.com",
"eks-nodegroup.amazonaws.com",
"elasticloadbalancing.amazonaws.com",
"ec2-nat-gateway.amazonaws.com"
]
}
}
},
{
"Sid": "OceanBaseCreateAndAttachPoliciesToIamRoles",
"Effect": "Allow",
"Action": [
"iam:CreateRole",
"iam:AttachRolePolicy"
],
"Resource": [
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/AmazonSSMRoleForInstancesQuickSetup",
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/OceanBaseBYOCEKSClusterRole",
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/OceanBaseBYOCEKSNodeRole",
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/AmazonEKS_EBS_CSI_DriverRole",
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/AmazonEKSLoadBalancerControllerRole"
]
},
{
"Sid": "OceanBaseCreateAndBindIamInstanceProfiles",
"Effect": "Allow",
"Action": [
"iam:CreateInstanceProfile",
"iam:AddRoleToInstanceProfile"
],
"Resource": [
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:instance-profile/AmazonSSMRoleForInstancesQuickSetup",
"arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:instance-profile/OceanBaseBYOCEKSNodeRole"
]
},
{
"Sid": "OceanBaseReadLoadBalancerControllerPolicy",
"Effect": "Allow",
"Action": [
"iam:GetPolicy",
"iam:GetPolicyVersion"
],
"Resource": "arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:policy/AWSLoadBalancerControllerIAMPolicy"
},
{
"Sid": "OceanBaseCreateLoadBalancerControllerPolicy",
"Effect": "Allow",
"Action": "iam:CreatePolicy",
"Resource": "arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:policy/AWSLoadBalancerControllerIAMPolicy"
},
{
"Sid": "OceanBasePassEbsCsiRoleToPodIdentity",
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": "arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/AmazonEKS_EBS_CSI_DriverRole",
"Condition": {
"StringEquals": {
"iam:PassedToService": "pods.eks.amazonaws.com"
}
}
},
{
"Sid": "OceanBasePassLbcRoleToPodIdentity",
"Effect": "Allow",
"Action": "iam:PassRole",
"Resource": "arn:aws:iam::<CUSTOMER_AWS_ACCOUNT_ID>:role/AmazonEKSLoadBalancerControllerRole",
"Condition": {
"StringEquals": {
"iam:PassedToService": "pods.eks.amazonaws.com"
}
}
},
{
"Sid": "OceanBaseListS3Buckets",
"Effect": "Allow",
"Action": "s3:ListAllMyBuckets",
"Resource": "*"
},
{
"Sid": "OceanBaseS3Access",
"Effect": "Allow",
"Action": "s3:*",
"Resource": [
"arn:aws:s3:::<BYOC_BUCKET_NAME>",
"arn:aws:s3:::<BYOC_BUCKET_NAME>/*"
]
}
]
}
信頼ポリシー:ロール作成時に設定する信頼エンティティと外部IDに対応し、ロールの信頼関係を確認するために使用されます。<OCEANBASE_AWS_ACCOUNT_ID>をOceanBase Cloudの権限付与ポップアップで提供されるメインアカウントIDに、<CUSTOMER_UNIQUE_EXTERNAL_ID>をOceanBase Cloudの権限付与ポップアップで提供される外部ID(External ID)に置き換えてください。
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "AllowOceanBaseAccountToAssumeByocRole",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::<OCEANBASE_AWS_ACCOUNT_ID>:root"
},
"Action": "sts:AssumeRole",
"Condition": {
"StringEquals": {
"sts:ExternalId": "<CUSTOMER_UNIQUE_EXTERNAL_ID>"
}
}
}
]
}