Skip to content

create role to allow user to run service catalogue's CLI package #1858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NovemberTang merged 1 commit into from
Mar 18, 2026
+168 −11
Merged

create role to allow user to run service catalogue's CLI package #1858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

105 changes: 105 additions & 0 deletions packages/cdk/lib/__snapshots__/service-catalogue.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ exports[`The ServiceCatalogue stack matches the snapshot 1`] = `
"GuLoggingStreamNameParameter",
"GuStringParameter",
"GuStringParameter",
"GuDeveloperPolicyExperimental",
"GuDistributionBucketParameter",
"GuScheduledLambda",
"GuAnghammaradTopicParameter",
Expand Down Expand Up @@ -24140,6 +24141,110 @@ spec:
"Type": "AWS::SecretsManager::Secret",
"UpdateReplacePolicy": "Delete",
},
"ServiceCatalogueCliPolicy7789F330": {
"Properties": {
"Description": "Service Catalogue CLI",
"Path": "/developer-policy/service-catalogue-cli/",
"PolicyDocument": {
"Statement": [
{
"Action": [
"ecs:RunTask",
"ecs:List*",
"ecs:Describe*",
],
"Effect": "Allow",
"Resource": {
"Fn::Join": [
"",
[
"arn:",
{
"Ref": "AWS::Partition",
},
":ecs:eu-west-1:",
{
"Ref": "AWS::AccountId",
},
":task/",
{
"Ref": "servicecatalogueCluster5FC34DC5",
},
"/*",
],
],
},
},
{
"Action": "ssm:GetParameter",
"Effect": "Allow",
"Resource": [
{
"Fn::Join": [
"",
[
"arn:",
{
"Ref": "AWS::Partition",
},
":ssm:eu-west-1:",
{
"Ref": "AWS::AccountId",
},
":parameter//PROD/deploy/service-catalogue/*",
],
],
},
{
"Fn::Join": [
"",
[
"arn:",
{
"Ref": "AWS::Partition",
},
":ssm:eu-west-1:",
{
"Ref": "AWS::AccountId",
},
":parameter//PROD/deploy/riff-raff/external-database-access-security-group",
],
],
},
{
"Fn::Join": [
"",
[
"arn:",
{
"Ref": "AWS::Partition",
},
":ssm:eu-west-1:",
{
"Ref": "AWS::AccountId",
},
":parameter//account/vpc/primary/subnets/private",
],
],
},
],
},
{
"Action": [
"secretsmanager:GetSecretValue",
"secretsmanager:ListSecrets",
],
"Effect": "Allow",
"Resource": {
"Ref": "PostgresInstance1SecretAttachmentBA0D257D",
},
},
],
"Version": "2012-10-17",
},
},
"Type": "AWS::IAM::ManagedPolicy",
},
"TopicBFC7AF6E": {
"Properties": {
"Tags": [
Expand Down
56 changes: 54 additions & 2 deletions packages/cdk/lib/cloudquery/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
import { GuardianAwsAccounts } from '@guardian/aws-account-setup';
import { NAMED_SSM_PARAMETER_PATHS } from '@guardian/cdk/lib/constants';
import type { GuStack } from '@guardian/cdk/lib/constructs/core';
import { GuStringParameter } from '@guardian/cdk/lib/constructs/core';
import { GuSecurityGroup } from '@guardian/cdk/lib/constructs/ec2';
import { GuS3Bucket } from '@guardian/cdk/lib/constructs/s3';
import type { GuWorkloadPolicyProps } from '@guardian/cdk/lib/experimental/constructs/iam/policies';
import { GuDeveloperPolicyExperimental } from '@guardian/cdk/lib/experimental/constructs/iam/policies';
import { Duration } from 'aws-cdk-lib';
import type { IVpc } from 'aws-cdk-lib/aws-ec2';
import { Secret } from 'aws-cdk-lib/aws-ecs';
import { Schedule } from 'aws-cdk-lib/aws-events';
import type { PolicyStatement } from 'aws-cdk-lib/aws-iam';
import { Effect, PolicyStatement } from 'aws-cdk-lib/aws-iam';
import type { DatabaseInstance } from 'aws-cdk-lib/aws-rds';
import { Secret as SecretsManager } from 'aws-cdk-lib/aws-secretsmanager';
import { StringParameter } from 'aws-cdk-lib/aws-ssm';
Expand Down Expand Up @@ -61,6 +64,14 @@ interface CloudqueryEcsClusterProps {
enableCloudquerySchedules: boolean;
}

function ssmArn(stack: GuStack, parameterName: string): string {
return stack.formatArn({
service: 'ssm',
resource: 'parameter',
resourceName: parameterName,
});
}

export function addCloudqueryEcsCluster(
scope: GuStack,
props: CloudqueryEcsClusterProps,
Expand Down Expand Up @@ -656,7 +667,7 @@ export function addCloudqueryEcsCluster(
config: endOfLifeSourceConfig(),
};

return new CloudqueryCluster(scope, `${app}Cluster`, {
const cluster = new CloudqueryCluster(scope, `${app}Cluster`, {
enableCloudquerySchedules,
app,
vpc,
Expand All @@ -678,4 +689,45 @@ export function addCloudqueryEcsCluster(
],
cloudqueryApiKey,
});

const SSMPolicy = new PolicyStatement({
effect: Effect.ALLOW,
actions: ['ssm:GetParameter'],
resources: [
ssmArn(scope, `/${stage}/${stack}/${app}/*`),
ssmArn(
scope,
`/${stage}/deploy/riff-raff/external-database-access-security-group`,
),
ssmArn(scope, NAMED_SSM_PARAMETER_PATHS.PrimaryVpcPrivateSubnets.path),
],
});

const cloudqueryClusterArnForTasks = cluster.arnForTasks('*');

const ecsPolicy = new PolicyStatement({
effect: Effect.ALLOW,
actions: ['ecs:RunTask', 'ecs:List*', 'ecs:Describe*'],
resources: [cloudqueryClusterArnForTasks],
});

const dbSecretPolicy = new PolicyStatement({
effect: Effect.ALLOW,
actions: ['secretsmanager:GetSecretValue', 'secretsmanager:ListSecrets'],
resources: [db.secret!.secretArn], // The secret definitely exists, as CloudQuery needs it to connect to the database.
});

const cliPolicyProps: GuWorkloadPolicyProps = {
permission: 'service-catalogue-cli',
description: 'Service Catalogue CLI',
statements: [ecsPolicy, SSMPolicy, dbSecretPolicy],
};

new GuDeveloperPolicyExperimental(
scope,
'ServiceCatalogueCliPolicy',
cliPolicyProps,
);

return cluster;
}
2 changes: 1 addition & 1 deletion packages/cdk/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
"devDependencies": {
"@guardian/aws-account-setup": "github:guardian/aws-account-setup#shared@0.0.1",
"@guardian/cdk": "62.5.1",
"@guardian/cdk": "62.5.3",
"@types/jest": "^30.0.0",
"@types/js-yaml": "^4.0.9",
"aws-cron-parser": "^1.1.12",
Expand Down
Loading