AWS opensearch-service documentation change
Summary
Updated terminology from 'YAML configuration' to 'pipeline configuration' throughout, simplified editable settings list, clarified IAM permission requirements, and fixed example ARN formatting
Security assessment
Changes focus on terminology consistency and documentation clarity. The IAM permission clarification explains when PassRole is required but doesn't introduce new security controls or address vulnerabilities.
Diff
diff --git a/opensearch-service/latest/developerguide/update-pipeline.md b/opensearch-service/latest/developerguide/update-pipeline.md index df0acc92e..44de3489f 100644 --- a/opensearch-service/latest/developerguide/update-pipeline.md +++ b/opensearch-service/latest/developerguide/update-pipeline.md @@ -9 +9 @@ ConsiderationsPermissions requiredUpdating pipelinesBlue/green deployments for p -You can update Amazon OpenSearch Ingestion pipelines using the AWS Management Console, the AWS CLI, or the OpenSearch Ingestion API. OpenSearch Ingestion initiates a blue/green deployment when you update a pipeline's YAML configuration. For more information, see Blue/green deployments for pipeline updates. +You can update Amazon OpenSearch Ingestion pipelines using the AWS Management Console, the AWS CLI, or the OpenSearch Ingestion API. OpenSearch Ingestion initiates a blue/green deployment when you update a pipeline configuration. For more information, see Blue/green deployments for pipeline updates. @@ -28 +28 @@ Consider the following when you update a pipeline: - * You can edit a pipeline's capacity limits, log publishing options, and YAML configuration. You can't edit its name or network settings. + * You can't edit a pipeline's name or network settings. @@ -34 +34 @@ Consider the following when you update a pipeline: - * When you update a pipeline's YAML configuration, OpenSearch Ingestion initiates a blue/green deployment. For more information, see Blue/green deployments for pipeline updates. + * When you update a pipeline configuration, OpenSearch Ingestion initiates a blue/green deployment. For more information, see Blue/green deployments for pipeline updates. @@ -36 +36 @@ Consider the following when you update a pipeline: - * When you update a pipeline's YAML configuration, OpenSearch Ingestion automatically upgrades your pipeline to the latest supported minor version of the major version of Data Prepper that's specified in the pipeline configuration. This process keeps your pipeline up to date with the latest bug fixes and performance improvements. + * When you update a pipeline configuration, OpenSearch Ingestion automatically upgrades the pipeline to the latest supported minor version of the major version of Data Prepper that's specified in the pipeline configuration. This process keeps your pipeline up to date with the latest bug fixes and performance improvements. @@ -51 +51 @@ OpenSearch Ingestion uses the following IAM permissions for updating pipelines: - * `iam:PassRole` – Pass the pipeline role to OpenSearch Ingestion so that it can write data to the domain. This permission is only required if you're updating the pipeline YAML configuration, not if you're modifying other settings such as log publishing or capacity limits. + * `iam:PassRole` – Pass the pipeline role to OpenSearch Ingestion so that it can write data to the domain. This permission is only required if you're updating the pipeline configuration, not if you're modifying other settings such as log publishing or capacity limits. @@ -72 +72 @@ For example, the following policy grants permission to update a pipeline: - "arn:aws:iam::{your-account-id}:role/{pipeline-role}" + "arn:aws:iam::your-account-id:role/pipeline-role" @@ -92 +92 @@ You can update Amazon OpenSearch Ingestion pipelines using the AWS Management Co - 3. Choose a pipeline to open its settings. You can edit a pipeline's capacity limits, log publishing options, and YAML configuration. You can't edit its name or network settings. + 3. Choose a pipeline to open its settings. Then, choose one of the **Edit** options. @@ -112 +112 @@ To update an OpenSearch Ingestion pipeline using the OpenSearch Ingestion API, c -OpenSearch Ingestion initiates a _blue/green_ deployment process when you update a pipeline's YAML configuration. +OpenSearch Ingestion initiates a _blue/green_ deployment process when you update a pipeline configuration. @@ -118 +118 @@ OpenSearch Ingestion blocks auto-scaling during blue/green deployments. You cont -When you update a pipeline's YAML configuration file, OpenSearch Ingestion can automatically upgrade your pipeline to the latest supported minor version of the major version of Data Prepper that's specified in the pipeline configuration. For example, you might have `version: "2"` in your pipeline configuration, and OpenSearch Ingestion initially provisioned the pipeline with version 2.1.0. When support for version 2.1.1 is added, and you make a change to your pipeline configuration, OpenSearch Ingestion upgrades your pipeline to version 2.1.1. +When you update a pipeline configuration file, OpenSearch Ingestion can automatically upgrade your pipeline to the latest supported minor version of the major version of Data Prepper that's specified in the pipeline configuration. For example, you might have `version: "2"` in your pipeline configuration, and OpenSearch Ingestion initially provisioned the pipeline with version 2.1.0. When support for version 2.1.1 is added, and you make a change to your pipeline configuration, OpenSearch Ingestion upgrades your pipeline to version 2.1.1.