Skip to content

Commit

Permalink
Split Docs providers to /docs & create assets dir
Browse files Browse the repository at this point in the history
  • Loading branch information
mcbenjemaa committed Apr 7, 2021
1 parent a0fbc64 commit 2f784ed
Show file tree
Hide file tree
Showing 24 changed files with 748 additions and 792 deletions.
817 changes: 25 additions & 792 deletions README.md

Large diffs are not rendered by default.

File renamed without changes
35 changes: 35 additions & 0 deletions docs/cloudflare.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
### Use with Cloudflare

Example using a Cloudflare API Key and corresponding email:
```
export CLOUDFLARE_API_KEY=[CLOUDFLARE_API_KEY]
export CLOUDFLARE_EMAIL=[CLOUDFLARE_EMAIL]
export CLOUDFLARE_ACCOUNT_ID=[CLOUDFLARE_ACCOUNT_ID]
./terraformer import cloudflare --resources=firewall,dns
```

or using a Cloudflare API Token:

```
export CLOUDFLARE_API_TOKEN=[CLOUDFLARE_API_TOKEN]
export CLOUDFLARE_ACCOUNT_ID=[CLOUDFLARE_ACCOUNT_ID]
./terraformer import cloudflare --resources=firewall,dns
```

List of supported Cloudflare services:

* `access`
* `cloudflare_access_application`
* `dns`
* `cloudflare_zone`
* `cloudflare_record`
* `firewall`
* `cloudflare_access_rule`
* `cloudflare_filter`
* `cloudflare_firewall_rule`
* `cloudflare_zone_lockdown`
* `cloudflare_rate_limit`
* `page_rule`
* `cloudflare_page_rule`
* `account_member`
* `cloudflare_account_member`
33 changes: 33 additions & 0 deletions docs/commercetools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
### Use with [Commercetools](https://commercetools.com/de/)

This provider use the [terraform-provider-commercetools](https://github.com/labd/terraform-provider-commercetools). The terraformer provider was build by [Dustin Deus](https://github.com/StarpTech).

Example:

```
CTP_CLIENT_ID=foo CTP_CLIENT_SCOPE=scope CTP_CLIENT_SECRET=bar CTP_PROJECT_KEY=key ./terraformer plan commercetools -r=types // Only planning
CTP_CLIENT_ID=foo CTP_CLIENT_SCOPE=scope CTP_CLIENT_SECRET=bar CTP_PROJECT_KEY=key ./terraformer import commercetools -r=types // Import commercetools types
```

List of supported [commercetools](https://commercetools.com/de/) resources:

* `api_extension`
* `commercetools_api_extension`
* `channel`
* `commercetools_channel`
* `product_type`
* `commercetools_product_type`
* `shipping_method`
* `commercetools_shipping_method`
* `shipping_zone`
* `commercetools_shipping_zone`
* `state`
* `commercetools_state`
* `store`
* `commercetools_store`
* `subscription`
* `commercetools_subscription`
* `tax_category`
* `commercetools_tax_category`
* `types`
* `commercetools_type`
74 changes: 74 additions & 0 deletions docs/datadog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
### Use with Datadog

Example:

```
./terraformer import datadog --resources=monitor --api-key=YOUR_DATADOG_API_KEY // or DATADOG_API_KEY in env --app-key=YOUR_DATADOG_APP_KEY // or DATADOG_APP_KEY in env --api-url=DATADOG_API_URL // or DATADOG_HOST in env
./terraformer import datadog --resources=monitor --filter=monitor=id1:id2:id4 --api-key=YOUR_DATADOG_API_KEY // or DATADOG_API_KEY in env --app-key=YOUR_DATADOG_APP_KEY // or DATADOG_APP_KEY in env
```

List of supported Datadog services:

* `dashboard`
* `datadog_dashboard`
* `dashboard_list`
* `datadog_dashboard_list`
* `downtime`
* `datadog_downtime`
* `logs_archive`
* `datadog_logs_archive`
* `logs_archive_order`
* `datadog_logs_archive_order`
* `logs_custom_pipeline`
* `datadog_logs_custom_pipeline`
* `logs_integration_pipeline`
* `datadog_logs_integration_pipeline`
* `logs_pipeline_order`
* `datadog_logs_pipeline_order`
* `logs_index`
* `datadog_logs_index`
* `logs_index_order`
* `datadog_logs_index_order`
* `integration_aws`
* `datadog_integration_aws`
* `integration_aws_lambda_arn`
* `datadog_integration_aws_lambda_arn`
* `integration_aws_log_collection`
* `datadog_integration_aws_log_collection`
* `integration_azure`
* `datadog_integration_azure`
* **_NOTE:_** Sensitive field `client_secret` is not generated and needs to be manually set
* `integration_gcp`
* `datadog_integration_gcp`
* **_NOTE:_** Sensitive fields `private_key, private_key_id, client_id` is not generated and needs to be manually set
* `integration_pagerduty`
* `datadog_integration_pagerduty`
* `integration_pagerduty_service_object`
* `datadog_integration_pagerduty_service_object`
* `metric_metadata`
* `datadog_metric_metadata`
* **_NOTE:_** Importing resource requires resource ID's to be passed via [Filter](#filtering) option
* `monitor`
* `datadog_monitor`
* `role`
* `datadog_role`
* `screenboard`
* `datadog_screenboard`
* `security_monitoring_default_rule`
* `datadog_security_monitoring_default_rule`
* `security_monitoring_rule`
* `datadog_security_monitoring_rule`
* `service_level_objective`
* `datadog_service_level_objective`
* **_NOTE:_** Importing resource requires resource ID's to be passed via [Filter](#filtering) option
* `synthetics`
* `datadog_synthetics_test`
* `synthetics_global_variables`
* `datadog_synthetics_global_variables`
* **_NOTE:_** Importing resource requires resource ID's to be passed via [Filter](#filtering) option
* `synthetics_private_location`
* `datadog_synthetics_private_location`
* `timeboard`
* `datadog_timeboard`
* `user`
* `datadog_user`
47 changes: 47 additions & 0 deletions docs/digitalocean.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
### Use with DigitalOcean

Example:

```
export DIGITALOCEAN_TOKEN=[DIGITALOCEAN_TOKEN]
./terraformer import digitalocean -r project,droplet
```

List of supported DigitalOcean resources:

* `cdn`
* `digitalocean_cdn`
* `certificate`
* `digitalocean_certificate`
* `database_cluster`
* `digitalocean_database_cluster`
* `digitalocean_database_connection_pool`
* `digitalocean_database_db`
* `digitalocean_database_replica`
* `digitalocean_database_user`
* `domain`
* `digitalocean_domain`
* `digitalocean_record`
* `droplet`
* `digitalocean_droplet`
* `droplet_snapshot`
* `digitalocean_droplet_snapshot`
* `firewall`
* `digitalocean_firewall`
* `floating_ip`
* `digitalocean_floating_ip`
* `kubernetes_cluster`
* `digitalocean_kubernetes_cluster`
* `digitalocean_kubernetes_node_pool`
* `loadbalancer`
* `digitalocean_loadbalancer`
* `project`
* `digitalocean_project`
* `ssh_key`
* `digitalocean_ssh_key`
* `tag`
* `digitalocean_tag`
* `volume`
* `digitalocean_volume`
* `volume_snapshot`
* `digitalocean_volume_snapshot`
19 changes: 19 additions & 0 deletions docs/fastly.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### Use with Fastly

Example:

```
export FASTLY_API_KEY=[FASTLY_API_KEY]
export FASTLY_CUSTOMER_ID=[FASTLY_CUSTOMER_ID]
./terraformer import fastly -r service_v1,user
```

List of supported Fastly resources:

* `service_v1`
* `fastly_service_acl_entries_v1`
* `fastly_service_dictionary_items_v1`
* `fastly_service_dynamic_snippet_content_v1`
* `fastly_service_v1`
* `user`
* `fastly_user_v1`
35 changes: 35 additions & 0 deletions docs/github.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
### Use with GitHub

Example:

```
./terraformer import github --organizations=YOUR_ORGANIZATION --resources=repositories --token=YOUR_TOKEN // or GITHUB_TOKEN in env
./terraformer import github --organizations=YOUR_ORGANIZATION --resources=repositories --filter=repository=id1:id2:id4 --token=YOUR_TOKEN // or GITHUB_TOKEN in env
```

Supports only organizational resources. List of supported resources:

* `members`
* `github_membership`
* `organization_blocks`
* `github_organization_block`
* `organization_projects`
* `github_organization_project`
* `organization_webhooks`
* `github_organization_webhook`
* `repositories`
* `github_repository`
* `github_repository_webhook`
* `github_branch_protection`
* `github_repository_collaborator`
* `github_repository_deploy_key`
* `teams`
* `github_team`
* `github_team_membership`
* `github_team_repository`
* `user_ssh_keys`
* `github_user_ssh_key`

Notes:
* Terraformer can't get webhook secrets from the GitHub API. If you use a secret token in any of your webhooks, running `terraform plan` will result in a change being detected:
=> `configuration.#: "1" => "0"` in tfstate only.
27 changes: 27 additions & 0 deletions docs/gmailfilter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
### Use with GmailFilter

Support [Using Service Accounts](https://github.com/yamamoto-febc/terraform-provider-gmailfilter/blob/master/README.md#using-a-service-accountg-suite-users-only) or [Using Application Default Credentials](https://github.com/yamamoto-febc/terraform-provider-gmailfilter/blob/master/README.md#using-an-application-default-credential).

Example:

```
# Using Service Accounts
export GOOGLE_CREDENTIALS=/path/to/client_secret.json
export IMPERSONATED_USER_EMAIL="[email protected]"
# Using Application Default Credentials
gcloud auth application-default login \
--client-id-file=client_secret.json \
--scopes \
https://www.googleapis.com/auth/gmail.labels,\
https://www.googleapis.com/auth/gmail.settings.basic
./terraformer import gmailfilter -r=filter,label
```

List of supported GmailFilter resources:

* `label`
* `gmailfilter_label`
* `filter`
* `gmailfilter_filter`
45 changes: 45 additions & 0 deletions docs/heroku.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
### Use with Heroku

Example:

```
export HEROKU_EMAIL=[HEROKU_EMAIL]
export HEROKU_API_KEY=[HEROKU_API_KEY]
./terraformer import heroku -r app,addon
```

List of supported Heroku resources:

* `account_feature`
* `heroku_account_feature`
* `addon`
* `heroku_addon`
* `addon_attachment`
* `heroku_addon_attachment`
* `app`
* `heroku_app`
* `app_config_association`
* `heroku_app_config_association`
* `app_feature`
* `heroku_app_feature`
* `app_webhook`
* `heroku_app_webhook`
* `build`
* `heroku_build`
* `cert`
* `heroku_cert`
* `domain`
* `heroku_domain`
* `drain`
* `heroku_drain`
* `formation`
* `heroku_formation`
* `pipeline`
* `heroku_pipeline`
* `pipeline_coupling`
* `heroku_pipeline_coupling`
* `team_collaborator`
* `heroku_team_collaborator`
* `team_member`
* `heroku_team_member`

49 changes: 49 additions & 0 deletions docs/keycloak.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
### Use with Keycloak

Example:

```
export KEYCLOAK_URL=https://foo.bar.localdomain
export KEYCLOAK_CLIENT_ID=[KEYCLOAK_CLIENT_ID]
export KEYCLOAK_CLIENT_SECRET=[KEYCLOAK_CLIENT_SECRET]
terraformer import keycloak --resources=realms
terraformer import keycloak --resources=realms --filter=realm=name1:name2:name3
terraformer import keycloak --resources=realms --targets realmA,realmB
```

Here is the list of resources which are currently supported by Keycloak provider v.1.19.0:

- `realms`
- `keycloak_default_groups`
- `keycloak_group`
- `keycloak_group_memberships`
- `keycloak_group_roles`
- `keycloak_ldap_full_name_mapper`
- `keycloak_ldap_group_mapper`
- `keycloak_ldap_hardcoded_group_mapper`
- `keycloak_ldap_hardcoded_role_mapper`
- `keycloak_ldap_msad_lds_user_account_control_mapper`
- `keycloak_ldap_msad_user_account_control_mapper`
- `keycloak_ldap_user_attribute_mapper`
- `keycloak_ldap_user_federation`
- `keycloak_openid_audience_protocol_mapper`
- `keycloak_openid_client`
- `keycloak_openid_client_default_scopes`
- `keycloak_openid_client_optional_scopes`
- `keycloak_openid_client_scope`
- `keycloak_openid_client_service_account_role`
- `keycloak_openid_full_name_protocol_mapper`
- `keycloak_openid_group_membership_protocol_mapper`
- `keycloak_openid_hardcoded_claim_protocol_mapper`
- `keycloak_openid_hardcoded_group_protocol_mapper`
- `keycloak_openid_hardcoded_role_protocol_mapper` (only for client roles)
- `keycloak_openid_user_attribute_protocol_mapper`
- `keycloak_openid_user_property_protocol_mapper`
- `keycloak_openid_user_realm_role_protocol_mapper`
- `keycloak_openid_user_client_role_protocol_mapper`
- `keycloak_openid_user_session_note_protocol_mapper`
- `keycloak_realm`
- `keycloak_required_action`
- `keycloak_role`
- `keycloak_user`
Loading

0 comments on commit 2f784ed

Please sign in to comment.