Skip to content

Commit

Permalink
Revisions for terraform guide (FusionAuth#2691)
Browse files Browse the repository at this point in the history
* initial import of adoc

* initial port to markdown

* Finished port over to mdx

* broke out limitations, added to limitations laundry list

* full review and workthrough

* update terraform section

* break out simple kickstart for inclusion/use elsewhere

* run through spellcheck, added needed image

* removing absolute urls

* add note about default theme

* reworking object references (which are capitalized)

* fix grammar error
  • Loading branch information
mooreds authored Nov 22, 2023
1 parent 5b79704 commit e43a6c9
Show file tree
Hide file tree
Showing 8 changed files with 456 additions and 14 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import DowntimeUpgradeLimitation from 'src/content/docs/get-started/core-concept
import ConfigurationLimits from 'src/content/docs/get-started/core-concepts/_configuration-limits.mdx';
import ScimLimits from 'src/content/docs/_shared/_scim-limits.mdx';
import TemplateContentLimits from 'src/content/docs/_shared/_template-content-limits.mdx';
import TerraformLimitations from 'src/content/docs/operate/deploy/_terraform-limitations.mdx';


## Overview

Expand Down Expand Up @@ -137,6 +139,10 @@ If you need to migrate hashes from FusionAuth to any other system, use a databas

<TemplateContentLimits />

## Terraform Limitations

<TerraformLimitations />

## What's Not Limited

All other objects and configuration, including but not limited to the following, are limited only by the resources of your system:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import InlineField from 'src/components/InlineField.astro';
import APIBlock from 'src/components/api/APIBlock.astro';
import APIField from 'src/components/api/APIField.astro';
import DefaultEntities from 'src/content/docs/_shared/_default-entities.mdx';
import JSON from 'src/components/JSON.astro';
import KickstartLicenseText from 'src/content/docs/_shared/_kickstart-license-text.mdx';
import KickstartTroubleshooting from 'src/content/docs/get-started/download-and-install/development/_kickstart-troubleshooting.mdx';

Expand Down Expand Up @@ -44,15 +45,7 @@ The examples found here, as well as community contributed examples may also be f

Here is the simplest kickstart file you can use, it simply adds a single API key and that's it. This may be useful if you intend to complete the rest of your setup by calling APIs in your own application or development setup script.

```json
{
"apiKeys": [
{
"key": "4737ea8520bd454caabb7cb3d36e14bc1832c0d3f70a4189b82598670f11b1bd"
}
]
}
```
<JSON title="Simplest Possible Kickstart File" src="kickstart/simplest-kickstart.json" />

This API key can be any string, and you should specify one unique to your FusionAuth instance. This value should ideally be a long random value. Please don't use the above key in a production environment.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
You must create an API key either manually or via Kickstart. There is no way to create the initial API key using Terraform.

The Terraform implementation is not currently at parity with the client libraries and the REST API. If you run into any discrepancies that affect your usages, please open a [GitHub issue](https://github.com/FusionAuth/terraform-provider-fusionauth).

Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,11 @@ Using this approach gives you full access to the FusionAuth API.

### Terraform

There is a community supported, open source terraform provider which allows you to manage FusionAuth using Terraform, an open source infrastructure tool.
There is an open source terraform provider which allows you to manage FusionAuth using Terraform, an open source infrastructure tool.

Here is the [FusionAuth Terraform provider documentation](https://registry.terraform.io/providers/gpsinsight/fusionauth/latest/docs).
Here is the [FusionAuth Terraform provider documentation](https://registry.terraform.io/providers/fusionauth/fusionauth/latest/docs).

Since it is a community project, it is not as complete as the client libraries. If you find yourself needing to manage something not currently supported, you can contribute to the [project using GitHub](https://github.com/gpsinsight/terraform-provider-fusionauth).

{/* TODO example */}
There is a [FusionAuth and Terraform guide](/docs/operate/deploy/terraform) which goes into more details about how use these technologies together.

### Pulumi

Expand Down
434 changes: 434 additions & 0 deletions astro/src/content/docs/operate/deploy/terraform.mdx

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions astro/src/content/json/kickstart/simplest-kickstart.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"apiKeys": [
{
"key": "4737ea8520bd454caabb7cb3d36e14bc1832c0d3f70a4189b82598670f11b1bd"
}
]
}

0 comments on commit e43a6c9

Please sign in to comment.