Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaxxstorm committed Oct 20, 2023
1 parent dd98a0e commit 1ae1486
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 11 deletions.
49 changes: 49 additions & 0 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,52 @@ meta_desc: Provides an overview of the AWS Control Tower package for Pulumi
layout: overview
---

The AWS Control Tower provider for Pulumi can be used to provision AWS account with [AWS Control Tower](https://aws.amazon.com/controltower/).

The AWS Control Tower provider must be configured with the required permissions to manage AWS accounts in AWS Control Tower.

## Example

{{< chooser language "typescript,python" >}}
{{% choosable language typescript %}}

```typescript

import * as controltower from "@lbrlabs/pulumi-awscontroltower";

const account = new controltower.ControlTowerAwsAccount("account", {
organizationalUnit: "Production",
email: "mail@example.com",
name: "Some User",
organizationalUnitIdOnDelete: "ou-48hfnvbc-ufo",
closeAccountOnDelete: true,
sso: {
firstName: "Some",
lastName: "User",
email: "mail@example.com",
},
});
```

{{% /choosable %}}
{{% choosable language python %}}

```python
import lbrlabs_pulumi_aws_controltower as controltower

account = controltower.ControlTowerAwsAccount(
"account",
organizational_unit="Production",
email="mail@example.com",
name="Some User",
organizational_unit_id_on_delete="ou-48hfnvbc-ufo",
close_account_on_delete=True,
sso={
"firstName": "Some",
"lastName": "User",
"email": "mail@example.com"
}
```

{{% /choosable %}}
{{< /chooser >}}
42 changes: 31 additions & 11 deletions docs/installation-configuration.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,53 @@
---
title: AWS Control Tower Setup
title: AWS Control Tower Installation & Configuration
meta_desc: Information on how to install the AWS Control Tower provider.
layout: installation
layout: package
---

## Installation

The Pulumi AWS Control Tower provider is available as a package in all Pulumi languages:

* JavaScript/TypeScript: [`@lbrlabs/pulumi-awscontroltower`](https://www.npmjs.com/package/@lbrlabs/pulumi-awscontroltower)
* Python: [`lbrlabs_pulumi_awscontroltower`](https://pypi.org/project/lbrlabs-pulumi-awscontroltower/)
* Go: [`github.com/lbrlabs/pulumi-awscontroltower/sdk/go/awscontroltower`](https://pkg.go.dev/github.com/lbrlabs/pulumi-awscontroltower/sdk)
* .NET: [`Lbrlabs.PulumiPackage.Awscontroltower`](https://www.nuget.org/packages/Lbrlabs.PulumiPackage.Awscontroltower)
* JavaScript/TypeScript: [`@lbrlabs/pulumi-awscontroltwer`](https://www.npmjs.com/package/@lbrlabs/pulumi-awscontroltwer)
* Python: [`lbrlabs_pulumi_aws_controltwer`](https://pypi.org/project/lbrlabs-pulumi-aws-controltower/)
* Go: [`github.com/lbrlabs/pulumi-awscontroltower/sdk/go/controltwer`](https://pkg.go.dev/github.com/lbrlabs/pulumi-awscontroltower/sdk)
* .NET: [`Lbrlabs.PulumiPackage.Scaleway`](https://www.nuget.org/packages/Lbrlabs.PulumiPackage.Awscontroltower)

### Provider Binary

The AWS Control Tower provider binary is a third party binary. It can be installed using the `pulumi plugin` command.
The AWS control tower provider binary is a third party binary. It can be installed using the `pulumi plugin` command.

```bash
pulumi plugin install resource awscontroltower <version>
pulumi plugin install resource awscontroltower --server github://api.github.com/lbrlabs
```

Replace the version string with your desired version.

## Setup

Coming soon
The AWS control tower uses the AWS SDK to connect to AWS. Many of the authentication options you're familiar with using [Pulumi AWS)(https://www.pulumi.com/registry/packages/aws/) apply here.

### Set environment variables
{{% /choosable %}}

Coming soon
{{% choosable os macos %}}

```bash
$ export AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
$ export AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
```

{{% /choosable %}}

{{% choosable os windows %}}

```powershell
> $env:AWS_ACCESS_KEY_ID = "<AWS_ACCESS_KEY_ID>"
> $env:AWS_SECRET_ACCESS_KEY = "<AWS_SECRET_ACCESS_KEY>"
```

{{% /choosable %}}
{{< /chooser >}}

## Configuration Options

Use `pulumi config set awscontroltower:<option>` or pass options to the [constructor of `new awscontroltower.Provider`]({{< relref "/registry/packages/awscontroltower/api-docs/provider" >}}).
2 changes: 2 additions & 0 deletions examples/yaml/Pulumi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@ resources:
firstName: "Lee"
lastName: "Briggs"
email: "lee@brig.gs"
options:
pluginDownloadUrl: "github://api.github.com/lbrlabs"

0 comments on commit 1ae1486

Please sign in to comment.