Skip to content

Commit 6bf61cd

Browse files
committed
resource_gitlab_group_ldap_link: Update docs
Add a note about the `ldap_provider` not being the LDAP `label` value and add information on how to receive the LDAP server name using a rake task. Fixes https://github.com/gitlabhq/terraform-provider-gitlab/issues/605
1 parent 941e9ee commit 6bf61cd

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/resources/group_ldap_link.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ resource "gitlab_group_ldap_link" "test" {
3131

3232
- `cn` (String) The CN of the LDAP group to link with.
3333
- `group_id` (String) The id of the GitLab group.
34-
- `ldap_provider` (String) The name of the LDAP provider as stored in the GitLab database.
34+
- `ldap_provider` (String) The name of the LDAP provider as stored in the GitLab database. Note that this is NOT the value of the `label` attribute as shown in the web UI. In most cases this will be `ldapmain` but you may use the [LDAP check rake task](https://docs.gitlab.com/ee/administration/raketasks/ldap.html#check) for receiving the LDAP server name: `LDAP: ... Server: ldapmain`
3535

3636
### Optional
3737

internal/provider/resource_gitlab_group_ldap_link.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ var _ = registerResource("gitlab_group_ldap_link", func() *schema.Resource {
5757
},
5858
// Changing GitLab API parameter "provider" to "ldap_provider" to avoid clashing with the Terraform "provider" key word
5959
"ldap_provider": {
60-
Description: "The name of the LDAP provider as stored in the GitLab database.",
60+
Description: "The name of the LDAP provider as stored in the GitLab database. Note that this is NOT the value of the `label` attribute as shown in the web UI. In most cases this will be `ldapmain` but you may use the [LDAP check rake task](https://docs.gitlab.com/ee/administration/raketasks/ldap.html#check) for receiving the LDAP server name: `LDAP: ... Server: ldapmain`",
6161
Type: schema.TypeString,
6262
Required: true,
6363
ForceNew: true,

0 commit comments

Comments
 (0)