Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the provider's documentation regarding the apikey and secretkey #42

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update the provider's documentation regarding the apikey and secretkey #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
605687c
fix: make apikey and secretkey optional and document the Environment …
Nov 3, 2023
54f8262
docs: various whitespace fixes
Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)

<img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">
![HashiCorp Terraform Logo](images/Terraform_PrimaryLogo_Color_RGB.svg)


Requirements
Expand Down Expand Up @@ -59,11 +59,14 @@ resource "dme_domain" "example" {

```

The `apikey` and `secretkey` can be sourced from the following Environment Variables:
* `DME_API_KEY`
* `DME_SECRET_KEY`

```
terraform plan -parallelism=1
terraform apply -parallelism=1
```
```

Developing The Provider
-----------------------
Expand Down
4 changes: 2 additions & 2 deletions dme/provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ func Provider() terraform.ResourceProvider {
Schema: map[string]*schema.Schema{
"api_key": &schema.Schema{
Type: schema.TypeString,
Required: true,
Required: false,
Description: "API key for HTTP call",
DefaultFunc: schema.EnvDefaultFunc("DME_API_KEY", nil),
},

"secret_key": &schema.Schema{
Type: schema.TypeString,
Required: true,
Required: false,
Description: "Secret Key for HMAC",
DefaultFunc: schema.EnvDefaultFunc("DME_SECRET_KEY", nil),
},
Expand Down
1 change: 1 addition & 0 deletions images/Terraform_PrimaryLogo_Color_RGB.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions website/docs/index.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ DNS Made Easy is a leading DNS service provider with a feature rich DNS services

Authentication
--------------
The Provider supports authentication with DME platform using API-key and SECRET-key.
The Provider supports authentication with DME platform using API-key and SECRET-key.

1. Authentication with user-id and password.
example:
1. Authentication with user-id and password.
example:

----------
```hcl
Expand Down Expand Up @@ -49,7 +49,7 @@ Argument Reference
------------------
Following arguments are supported with DNS Made Easy terraform provider.

* `api_key` - (Required) API key of a user which has the access to perform CRUD operations on all the DNS objects of DNS Made Easy platform.
* `secret_key` - (Required) Secret key of a user which has the access to perform CRUD operations on all the DNS objects of DNS Made Easy platform.
* `insecure` - (Optional) This determines whether to use insecure HTTP connection or not. Default value is `true`.
* `api_key` - (Optional) API key of a user which has the access to perform CRUD operations on all the DNS objects of DNS Made Easy platform. This can also be sourced from the `DME_API_KEY` Environment Variable.
* `secret_key` - (Optional) Secret key of a user which has the access to perform CRUD operations on all the DNS objects of DNS Made Easy platform. This can also be sourced from the `DME_SECRET_KEY`
* `insecure` - (Optional) This determines whether to use insecure HTTP connection or not. Default value is `true`.
* `proxyurl` - (Optional) A proxy server URL when configured, all the requests to DNS Made Easy platform will be passed through the proxy-server configured.