Skip to content

Feat/Support for S3 source provider of ADF pipelines #798

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions docs/admin-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,23 @@ Config has five components in `main-notification-endpoint`, `scp`, `scm`,
temporarily).
- target AWS Accounts by tag with no AWS Accounts having that tag assigned
(yet).
- `codebase-source`, the value is a map which contains deployment map code source
configuration. if not set, it will use codecommit and handled by ADF.
- `source-type`, the source type deployment map pipeline. Can be
`codecommit` or `s3`, by default it is `codecommit`.
- `s3-bucket-name`, the S3 bucket name where the codebase is stored,
if not set, it will be created automatically with a random name.
(only used when source-type is s3)
- `s3-object-key`, the S3 key where the codebase is stored, by default,
it is set to `aws-deployment-framework-pipelines.zip`
(only used when source-type is s3).
- `s3-use-existing`, determines if the existing S3 bucket should be used.
By default, it is set to `disabled` (only used when source-type is s3).
If you want to specific configuration of your S3 bucket, you could use
the existing S3 bucket. Please make sure the existing S3 bucket have
following configuration:
- [versioning](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html)
- [S3 notifications](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications-eventbridge.html)
- `org` configures settings in case of staged multi-organization ADF deployments.
- `stage` defines the AWS Organization stage in case of staged multi-
organization ADF deployments. This is an optional setting. In enterprise-
Expand Down
64 changes: 64 additions & 0 deletions docs/installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,70 @@ Please update the configuration to use in the `adfconfig.yml`
file instead, as documented in the [adfconfig section in the Admin
Guide](./admin-guide.md#adfconfig).

#### Parameter SourceType

Optional, default value: (CodeCommit)

Example: `CodeCommit`

**Explanation:**
An optional string of Source Type of ADF Bootstrap pipeline, Currently only
support `S3` and `CodeCommit`.

*This is not required when performing an update between versions of ADF.*

Please note that changing this value will directly change the source provider of
ADF Boostrap pipeline in the management account.

#### Parameter S3SourceBucketName

Optional, default value: (empty)

Example: `aws-deployment-framework-bootstrap-pipeline-<management-account-id>`

**Explanation:**
An optional string specifying the S3 bucket name for the ADF Bootstrap source code.
This parameter is only applicable when SourceType is set to S3. If left empty while
SourceType is S3, a new bucket with a random name will be created automatically.

*This is not required when performing an update between versions of ADF.*
*only used when SourceType is S3*

#### Parameter S3SourceObjectKey

Optional, default value: (aws-deployment-framework-bootstrap.zip)

Example: `aws-deployment-framework-bootstrap.zip`

**Explanation:**
An optional string specifying the S3 object key for the ADF Bootstrap source code.
This parameter is only applicable when SourceType is set to S3.

*This is not required when performing an update between versions of ADF.*
*only used when SourceType is S3*

#### Parameter S3SourceUseExistingBucket

Optional, default value: (No)

Example: `No`

**Explanation:**
An optional string specifying whether to use an existing S3 bucket
for the ADF Bootstrap source code.
This parameter is only applicable when SourceType is set to S3.
If set to "Yes," the ADF Bootstrap source will be
directed to the existing S3 bucket.

Additionally, the bucket must be located in the ADF installation account.
The S3 bucket following configured:

- [versioning](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html)
- [S3 notifications](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications-eventbridge.html)

*This is not required when performing an update between versions of ADF.*
*only used when SourceType is S3*

#### Parameter LogLevel

Optional, default value: `INFO`
Expand Down
16 changes: 16 additions & 0 deletions src/lambda_codebase/initial_commit/adfconfig.yml.j2
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,22 @@ config:
allow-empty-target: disabled
# ^ Needs to be set to "enabled" to activate. Defaults to "disabled" when
# not set.
# Optional:
# codebase-source:
# ^ The source of the codebase configuration. if not set, it will use codecommit
# source-type: codecommit
# ^ The source of the codebase. Can be codecommit or s3, by default it is
# set to codecommit
# s3-bucket-name: aws-deployment-framework-pipelines-<deployment-account-id>
# ^ The S3 bucket name where the codebase is stored, if not set, it will be created
# (only used when source-type is s3)
# s3-object-key: aws-deployment-framework-pipelines.zip
# ^ The S3 key where the codebase is stored, by default, it is set to
# aws-deployment-framework-pipelines.zip (only used when source-type is s3)
# s3-use-existing: disabled
# ^ Determines if the existing S3 bucket should be used. By default, it is set to
# "disabled". (only used when source-type is s3)

# Optional config for multi-organization deployments of ADF:
# org:
# # Optional: Use this variable to define the AWS Organization in case of
Expand Down
Loading