Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

docs(partition): bring the partition pages up to date with the smoke coverage and EDGE rules (#5489)

Hector Ventura0d7189415351
diff --git a/docs/configuration/partitions.md b/docs/configuration/partitions.md
index 7b0a0d5c19..e70a6f2712 100644
--- a/docs/configuration/partitions.md
+++ b/docs/configuration/partitions.md
@@ -4,7 +4,8 @@ Floci serves every AWS partition, not only the commercial one. A partition is th
segment of every ARN (`arn:aws-cn:...`), the DNS suffix of every endpoint
(`amazonaws.com.cn`), and the set of services and regions AWS publishes there. Floci reads
all of it from AWS's own partition metadata (botocore's `partitions.json` and
-`endpoints.json`, vendored as `aws/partitions.json` and refreshed with `make aws-data-sync`).
+`endpoints.json`, vendored as `aws/partitions.json` and refreshed with `make aws-data-sync`,
+which also regenerates the AWS managed-policy catalog).
| Partition | DNS suffix | Regions | Example |
|---|---|---|---|
@@ -113,8 +114,8 @@ back to `aws` for a label no partition publishes.
and `aws-cn`; the SAML sign-on URL for five partitions. The ISO and EUSC regions have no load
balancer hosted zones, and only the two ISO-F regions have an S3 website zone; where a table has
no row the field is omitted rather than guessed. An `EDGE` API Gateway REST API or custom domain is
- refused outside the commercial partition (`BadRequestException`): GovCloud and ISO have no CloudFront,
- and China has no edge-optimized API Gateway
+ refused outside the commercial partition (`BadRequestException`): GovCloud, EUSC and ISO have no
+ CloudFront, and China has no edge-optimized API Gateway
([China API Gateway](https://docs.amazonaws.cn/en_us/aws/latest/userguide/api-gateway.html)).
- **VPC endpoint service names**: interface endpoints (as `DescribeVpcEndpointServices` lists them)
are `com.amazonaws.<region>.<service>` everywhere, except the (region, service) pairs the CDK
@@ -191,13 +192,13 @@ partition.
- **The partition rules themselves** (partition and region lookup, ARN minting, hostnames,
service principals, managed-policy rewriting, STS) have unit tests over all eight partitions.
-- **Through the emulator**, IAM ARNs and Step Functions run in all eight partitions, and a smoke
- test creates one resource in every non-commercial partition for SNS, Kinesis, Firehose, API
- Gateway V2, ELBv2, Glue, IoT, ACM, CodeBuild, Batch and EFS and checks its ARN or host. A new
- service that mints ARNs or hosts needs a case there or a recorded exemption. Most other
- partition-dependent behaviour (S3 bucket rules, EC2 regions and DNS names, hosted zones, VPC
- endpoint names, Lambda layers, CloudFormation pseudo-parameters, strict mode) is tested in one or
- two partitions, nearly always China.
+- **Through the emulator**, IAM ARNs run in all eight partitions, and a smoke test creates one
+ resource per service in every non-commercial partition that publishes the service and checks
+ its ARN or host. It covers every service that mints ARNs or hosts; the few without a case are
+ listed with the reason in `src/test/resources/partition/smoke-exemptions.tsv`, and a new
+ service needs a case there or a recorded exemption. Most other partition-dependent behaviour
+ (EC2 regions and DNS names, hosted zones, VPC endpoint names, Lambda layers, Step Functions
+ integration ids, strict mode) is tested in one or two partitions, nearly always China.
- **End to end**, the nightly Partition Compatibility workflow runs the Java SDK compatibility
suite against a Floci deployed with `FLOCI_DEFAULT_REGION=cn-north-1`, with the SDK clients
signing for `cn-north-1`, so the SDK's own China partition handling has to round-trip. Its list
@@ -226,8 +227,10 @@ These values have no published source Floci can cite, so it does not guess them;
the commercial value or Floci's own base host until sourced:
- the China CloudFront distribution domain suffix (only the API host is published);
-- the console device-authorization client ids (`arn:aws:signin:::devtools/...`) outside the
- commercial partition;
+- the console cross-device sign-in redirect host outside the commercial partition: besides the
+ endpoint the authorize request arrived on, the only AWS host Floci accepts is
+ `<region>.signin.aws.amazon.com` (the device-authorization client ids themselves,
+ `arn:aws:signin:::devtools/...`, are the same in every partition);
- the STS web-identity audience outside the commercial partition;
- the EKS Pod Identity token audience (`pods.eks.amazonaws.com`) outside the commercial partition;
- the Lambda function-URL host outside the commercial partition;
diff --git a/docs/services/appsync.md b/docs/services/appsync.md
index f11f57d327..b8a879d1d5 100644
--- a/docs/services/appsync.md
+++ b/docs/services/appsync.md
@@ -286,8 +286,7 @@ and RDS resolvers are not blocked by local IAM role checks. When it is on, Floci
configured `serviceRoleArn` before invoking a backing resource. A valid same-account role ARN
not present in Floci's IAM store remains permissive, as with STS AssumeRole. A known role must
belong to the data source's account and partition, trust
-the partition's AppSync service principal (for example, `appsync.amazonaws.com` in commercial
-Regions), and have identity-policy permission for the requested operation and
+the AppSync service principal (`appsync.amazonaws.com`, the same in every partition), and have identity-policy permission for the requested operation and
resource. An indexed DynamoDB Query or Scan checks the index ARN. RDS execution checks both
`rds-data:ExecuteStatement` on the cluster and `secretsmanager:GetSecretValue` on the secret.
Missing roles, missing trust, and insufficient permissions fail the field instead of calling
diff --git a/docs/services/lambda.md b/docs/services/lambda.md
index 6a149c5886..883e3d9d71 100644
--- a/docs/services/lambda.md
+++ b/docs/services/lambda.md
@@ -428,7 +428,7 @@ passes here and fails on deploy. The content is never mounted at `/opt` either w
is logged at attach time and again at invoke; publish your own copy of the content locally under a
name you control if the handler needs it at runtime.
-A layer ARN outside the `aws` partition is refused whatever that setting says. Partitions are
+A layer ARN outside the caller's partition is refused whatever that setting says. Partitions are
isolated, so no resource policy can ever make such a layer readable, and `GetLayerVersionByArn`
rejects one outright with `InvalidParameterValueException: Invalid layer version ...`.