Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.

Commit

Permalink
Updated docs to add support contact
Browse files Browse the repository at this point in the history
  • Loading branch information
sudiptad2017 committed Feb 24, 2022
1 parent ee4ec6d commit 5ba6919
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,17 @@ Kafka Manager Provider uses multiple ways of providing credentials.
The following methods are supported:

### Static credentials
Static credentials can be provided via an `key`, `user_id`, `supplier` and `okta_groups` in-line in the Kafka Manager provider block
Static credentials can be provided via `url` and `access_token` in-line in the Kafka Manager provider block

```hcl
provider "kafkamanager" {
url = "https://kafka-manager.foo.bar"
key = "fakedataplatformkeyfakedataplatformkeyfakedataplatformkeyfakedat"
okta_groups = "OKTA_GROUP"
supplier = "DEV"
user_id = "FAKEUSER"
url = "https://edp-microservices.awsedscinp.com/kafka-manager"
access_token = "fakeoauth2tokenheader.fakeoauth2tokenpayload.fakeoauth2tokensignature"
}
```

### Environment variables
You can provide your credentials via the `KAFKAMANAGER_URL`, `KAFKAMANAGER_KEY`, `KAFKAMANAGER_SUPPLIER`, `KAFKAMANAGER_USER_ID` and `KAFKAMANAGER_OKTA_GROUPS` environment variables.
You can provide your credentials via the `KAFKAMANAGER_URL`, `KAFKAMANAGER_ACCESS_TOKEN` environment variables.


## Using the provider
Expand All @@ -41,7 +38,7 @@ After configuring credintals in your prefered way you can start using this provi

Please note that Kafka Manager Provider only support creating/modifying/deleting topics for now.

### To create a topic:
### To create a topic:

```hcl
data "kafkamanager_cluster" "dev" {
Expand All @@ -60,7 +57,13 @@ resource "kafkamanager_topic" "my_topic" {
## Argument Reference

* `url` - (Required) The URL to Kafka Manager. Also read from ENV.KAFKAMANAGER_URL
* `key` - (Required) The access key from loadbalancer. Also read from ENV.KAFKAMANAGER_KEY
* `okta_groups` - (Required) The OKTA group name of your team. Also read from ENV.KAFKAMANAGER_OKTA_GROUPS
* `supplier` - (Required) Your data platform supplier code. Also read from ENV.KAFKAMANAGER_SUPPLIER
* `user_id` - (Required) Your data platform user ID. Also read from ENV.KAFKAMANAGER_USER_ID
* `access_token` - (Required) The access token from Okta. Also read from ENV.KAFKAMANAGER_ACCESS_TOKEN. For more details on how to set up Okta access please contact the email id below.

---
### Supported Versions

| Terraform 0.15.x |
| ------------------------ |
| Provider version < 0.0.3 |

For questions, please reach out to the Cox Automotive Data Platform team at [email protected]

0 comments on commit 5ba6919

Please sign in to comment.