Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lajos88 committed Oct 15, 2020
1 parent d2ec966 commit 9fa334b
Show file tree
Hide file tree
Showing 17 changed files with 130 additions and 130 deletions.
8 changes: 4 additions & 4 deletions docs/data-sources/configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ Use this data source to access information about existing **Configs**.
## Example Usage

```hcl
data "configcat_products" "products" {
data "configcat_products" "my_products" {
name_filter_regex = "ConfigCat's product"
}
data "configcat_configs" "configs" {
product_id = data.configcat_products.products.products.0.product_id
data "configcat_configs" "my_configs" {
product_id = data.configcat_products.my_products.products.0.product_id
name_filter_regex = "Main Config"
}
output "config_id" {
value = data.configcat_configs.configs.configs.0.config_id
value = data.configcat_configs.my_configs.configs.0.config_id
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ Use this data source to access information about existing **Environments**.
## Example Usage

```hcl
data "configcat_products" "products" {
data "configcat_products" "my_products" {
name_filter_regex = "ConfigCat's product"
}
data "configcat_environments" "environments" {
product_id = data.configcat_products.products.products.0.product_id
data "configcat_environments" "my_environments" {
product_id = data.configcat_products.my_products.products.0.product_id
name_filter_regex = "Test"
}
output "environment_id" {
value = data.configcat_environments.environments.environments.0.environment_id
value = data.configcat_environments.my_environments.environments.0.environment_id
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Use this data source to access information about existing **Organizations**.
## Example Usage

```hcl
data "configcat_organizations" "organizations" {
data "configcat_organizations" "my_organizations" {
name_filter_regex = "ConfigCat"
}
output "organization_id" {
value = data.configcat_organizations.organizations.organizations.0.organization_id
value = data.configcat_organizations.my_organizations.organizations.0.organization_id
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/products.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Use this data source to access information about existing **Products**.
## Example Usage

```hcl
data "configcat_products" "products" {
data "configcat_products" "my_products" {
name_filter_regex = "ConfigCat's product"
}
output "product_id" {
value = data.configcat_products.products.products.0.product_id
value = data.configcat_products.my_products.products.0.product_id
}
```

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ Use this data source to access information about existing **Feature Flags/Settin
## Example Usage

```hcl
data "configcat_products" "products" {
data "configcat_products" "my_products" {
name_filter_regex = "ConfigCat's product"
}
data "configcat_configs" "configs" {
product_id = data.configcat_products.products.products.0.product_id
data "configcat_configs" "my_configs" {
product_id = data.configcat_products.my_products.products.0.product_id
name_filter_regex = "Main Config"
}
data "configcat_settings" "settings" {
config_id = data.configcat_configs.configs.configs.0.config_id
config_id = data.configcat_configs.my_configs.configs.0.config_id
key_filter_regex = "isAwesomeFeatureEnabled"
}
Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ Use this data source to access information about existing **Tags**.
## Example Usage

```hcl
data "configcat_products" "products" {
data "configcat_products" "my_products" {
name_filter_regex = "ConfigCat's product"
}
data "configcat_tags" "tags" {
product_id = data.configcat_products.products.products.0.product_id
data "configcat_tags" "my_tags" {
product_id = data.configcat_products.my_products.products.0.product_id
name_filter_regex = "Test"
}
output "tag_id" {
value = data.configcat_tags.tags.tags.0.tag_id
value = data.configcat_tags.my_tags.tags.0.tag_id
}
```

Expand Down
68 changes: 34 additions & 34 deletions docs/guides/multi_environments.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Simple usage of Data sources
# Advanced usage of Resources in multiple environments

## Prerequisites

Expand All @@ -22,67 +22,67 @@ provider "configcat" {
}
// Organization Resource is ReadOnly.
data "configcat_organizations" "organizations" {
data "configcat_organizations" "my_organizations" {
name_filter_regex = "ConfigCat"
}
resource "configcat_product" "product" {
organization_id = data.configcat_organizations.organizations.organizations.0.organization_id
resource "configcat_product" "my_product" {
organization_id = data.configcat_organizations.my_organizations.organizations.0.organization_id
name = "My product"
}
resource "configcat_config" "config" {
product_id = configcat_product.product.id
resource "configcat_config" "my_config" {
product_id = configcat_product.my_product.id
name = "My config"
}
resource "configcat_setting" "is_awesome" {
config_id = configcat_config.config.id
config_id = configcat_config.my_config.id
key = "isAwesomeFeatureEnabled"
name = "My awesome feature flag"
hint = "This is the hint for my awesome feature flag"
setting_type = "boolean"
}
resource "configcat_setting" "welcome_text" {
config_id = configcat_config.config.id
config_id = configcat_config.my_config.id
key = "welcomeText"
name = "Welcome text"
hint = "Welcome text message shown on homepage"
setting_type = "text"
}
resource "configcat_tag" "tag" {
product_id = configcat_product.product.id
resource "configcat_tag" "created_by_terraform_tag" {
product_id = configcat_product.my_product.id
name = "Created by Terraform"
}
resource "configcat_setting_tag" "setting_tag" {
resource "configcat_setting_tag" "is_awesome_setting_tag" {
setting_id = configcat_setting.is_awesome.id
tag_id = configcat_tag.tag.id
tag_id = configcat_tag.created_by_terraform_tag.id
}
resource "configcat_setting_tag" "setting_tag" {
resource "configcat_setting_tag" "welcome_text_setting_tag" {
setting_id = configcat_setting.welcome_text.id
tag_id = configcat_tag.tag.id
tag_id = configcat_tag.created_by_terraform_tag.id
}
// Test module
module "test" {
source = "./test"
product_id = configcat_product.product.id
setting_is_awesome_id = configcat_setting.is_awesome.id
setting_welcome_text_id = configcat_setting.welcome_text.id
product_id = configcat_product.my_product.id
is_awesome_setting_id = configcat_setting.is_awesome.id
welcome_text_setting_id = configcat_setting.welcome_text.id
}
// Production module
module "production" {
source = "./production"
product_id = configcat_product.product.id
setting_is_awesome_id = configcat_setting.is_awesome.id
setting_welcome_text_id = configcat_setting.welcome_text.id
product_id = configcat_product.my_product.id
is_awesome_setting_id = configcat_setting.is_awesome.id
welcome_text_setting_id = configcat_setting.welcome_text.id
}
```

Expand All @@ -93,20 +93,20 @@ variable "product_id" { default = "" }
variable "setting_is_awesome_id" { default = "" }
variable "setting_welcome_text_id" { default = "" }
resource "configcat_environment" "environment" {
resource "configcat_environment" "test_environment" {
product_id = var.product_id
name = "Test"
}
resource "configcat_setting_value" "setting_value_is_awesome" {
environment_id = configcat_environment.environment.id
setting_id = var.setting_is_awesome_id
resource "configcat_setting_value" "is_awesome_value" {
environment_id = configcat_environment.test_environment.id
setting_id = var.is_awesome_setting_id
value = "true"
}
resource "configcat_setting_value" "setting_value_setting_welcome_text_id" {
environment_id = configcat_environment.environment.id
setting_id = var.setting_welcome_text_id
resource "configcat_setting_value" "welcome_text_value" {
environment_id = configcat_environment.test_environment.id
setting_id = var.welcome_text_setting_id
value = "Welcome to ConfigCat"
}
```
Expand All @@ -119,14 +119,14 @@ variable "product_id" { default = "" }
variable "setting_is_awesome_id" { default = "" }
variable "setting_welcome_text_id" { default = "" }
resource "configcat_environment" "environment" {
resource "configcat_environment" "production_environment" {
product_id = var.product_id
name = "Production"
}
resource "configcat_setting_value" "setting_value_is_awesome" {
environment_id = configcat_environment.environment.id
setting_id = var.setting_is_awesome_id
resource "configcat_setting_value" "is_awesome_value" {
environment_id = configcat_environment.production_environment.id
setting_id = var.is_awesome_setting_id
value = "false"
Expand All @@ -147,9 +147,9 @@ resource "configcat_setting_value" "setting_value_is_awesome" {
}
}
resource "configcat_setting_value" "setting_value_setting_welcome_text_id" {
environment_id = configcat_environment.environment.id
setting_id = var.setting_welcome_text_id
resource "configcat_setting_value" "welcome_text_value" {
environment_id = configcat_environment.production_environment.id
setting_id = var.welcome_text_setting_id
value = "Welcome to ConfigCat"
Expand Down
20 changes: 10 additions & 10 deletions docs/guides/simple_data_sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,31 @@ Get your ConfigCat Public API credentials at https://app.configcat.com/my-accoun
## root.tf

```hcl
data "configcat_organizations" "organizations" {
data "configcat_organizations" "my_organizations" {
name_filter_regex = "ConfigCat"
}
data "configcat_products" "products" {
data "configcat_products" "my_products" {
name_filter_regex = "ConfigCat's product"
}
data "configcat_configs" "configs" {
product_id = data.configcat_products.products.products.0.product_id
data "configcat_configs" "my_configs" {
product_id = data.configcat_products.my_products.products.0.product_id
name_filter_regex = "Main Config"
}
data "configcat_environments" "environments" {
product_id = data.configcat_products.products.products.0.product_id
data "configcat_environments" "my_environments" {
product_id = data.configcat_products.my_products.products.0.product_id
name_filter_regex = "Test"
}
data "configcat_settings" "settings" {
config_id = data.configcat_configs.configs.configs.0.config_id
data "configcat_settings" "my_settings" {
config_id = data.configcat_configs.my_configs.configs.0.config_id
key_filter_regex = "isAwesomeFeatureEnabled"
}
data "configcat_tags" "tags" {
product_id = data.configcat_products.products.products.0.product_id
data "configcat_tags" "my_tags" {
product_id = data.configcat_products.my_products.products.0.product_id
name_filter_regex = "Test"
}
```
34 changes: 17 additions & 17 deletions docs/guides/simple_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,36 +22,36 @@ provider "configcat" {
}
// Organization Resource is ReadOnly.
data "configcat_organizations" "organizations" {
data "configcat_organizations" "my_organizations" {
name_filter_regex = "ConfigCat"
}
resource "configcat_product" "product" {
organization_id = data.configcat_organizations.organizations.organizations.0.organization_id
resource "configcat_product" "my_product" {
organization_id = data.configcat_organizations.my_organizations.organizations.0.organization_id
name = "My product"
}
resource "configcat_config" "config" {
product_id = configcat_product.product.id
resource "configcat_config" "my_config" {
product_id = configcat_product.my_product.id
name = "My config"
}
resource "configcat_environment" "environment" {
product_id = configcat_product.product.id
resource "configcat_environment" "my_environment" {
product_id = configcat_product.my_product.id
name = "Production"
}
resource "configcat_setting" "setting" {
config_id = configcat_config.config.id
resource "configcat_setting" "is_awesome" {
config_id = configcat_config.my_config.id
key = "isAwesomeFeatureEnabled"
name = "My awesome feature flag"
hint = "This is the hint for my awesome feature flag"
setting_type = "boolean"
}
resource "configcat_setting_value" "setting_value" {
environment_id = configcat_environment.environment.id
setting_id = configcat_setting.setting.id
resource "configcat_setting_value" "is_awesome_value" {
environment_id = configcat_environment.my_environment.id
setting_id = configcat_setting.is_awesome.id
value = "true"
Expand All @@ -78,13 +78,13 @@ resource "configcat_setting_value" "setting_value" {
}
}
resource "configcat_tag" "tag" {
product_id = configcat_product.product.id
resource "configcat_tag" "my_tag" {
product_id = configcat_product.my_product.id
name = "Created by Terraform"
}
resource "configcat_setting_tag" "setting_tag" {
setting_id = configcat_setting.setting.id
tag_id = configcat_tag.tag.id
resource "configcat_setting_tag" "is_awesome_tag" {
setting_id = configcat_setting.is_awesome_tag.id
tag_id = configcat_tag.my_tag.id
}
```
Loading

0 comments on commit 9fa334b

Please sign in to comment.