Skip to content

Commit

Permalink
adding docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edgarsilva948 committed Sep 11, 2023
1 parent 1981d98 commit b1b47a3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 9 deletions.
12 changes: 6 additions & 6 deletions docs/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ Optionally, verify the checksum:

1. Download the checksum file: [latest](https://github.com/edgarsilva948/aftctl/releases/latest/download/checksums.txt)
2. Use Command Prompt to manually compare `CertUtil`'s output to the checksum file downloaded.
```cmd
REM Replace x86_64 with ARM64 or i386
CertUtil -hashfile aftctl_Windows_x86_64.zip SHA256
```
```cmd
# Replace x86_64 with ARM64 or i386
CertUtil -hashfile aftctl_Windows_x86_64.zip SHA256
```
3. Using PowerShell to automate the verification using the `-eq` operator to get a `True` or `False` result:
```pwsh
# Replace x86_64 with ARM64 or i386
(Get-FileHash -Algorithm SHA256 .\aftctl_Windows_x86_64.zip).Hash -eq ((Get-Content .\checksums.txt) -match 'aftctl_Windows_x86_64.zip' -split ' ')[0]
```
(Get-FileHash -Algorithm SHA256 .\aftctl_Windows_x86_64.zip).Hash -eq ((Get-Content .\checksums.txt) -match 'aftctl_Windows_x86_64.zip' -split ' ')[0]
```
27 changes: 24 additions & 3 deletions docs/docs/prereqs.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
### Prerequisite
### Credentials

You will need to have AWS API credentials from your Management Account configured.

???+ info
As described [`here`][AFT Deploy] you will need to have AdministratorAccess to allow AFT Account to launch products in AWS Control Tower Account Factory Portfolio.
As described [`here`][AFT Deploy] you will need to have AdministratorAccess to allow AFT Account to launch products from AWS Control Tower Account Factory Portfolio.

[AFT Deploy]: https://docs.aws.amazon.com/controltower/latest/userguide/aft-getting-started.html

You can use [`~/.aws/credentials` file][awsconfig]
or [environment variables][awsenv]. For more information read [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html).

[awsenv]: https://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html
[awsconfig]: https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html
[awsconfig]: https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html

### Foundation

An AWS Control Tower landing zone. For more information, see [Plan your AWS Control Tower landing zone.][plan]

A home Region for your AWS Control Tower landing zone. For more information, see [How AWS Regions work with AWS Control Tower][region].

A Terraform version and distribution. For more information, see [Terraform][tfversion] and [AFT versions][aftversion].

A VCS provider for tracking and managing changes to code and other files.

[tfversion]: https://releases.hashicorp.com/terraform/
[aftversion]: https://docs.aws.amazon.com/controltower/latest/userguide/version-supported.html
[region]: https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html
[plan]: https://docs.aws.amazon.com/controltower/latest/userguide/planning-your-deployment.html

### Organizations

Create a new organizational unit for AFT (Optional)

Provision the AFT management account

0 comments on commit b1b47a3

Please sign in to comment.