Skip to content

Commit 32c90b7

Browse files
authored
Improve migration guide location (#94)
* Improve migration guide location to proper location * Improve migration guide * Improve provider documentation * Improve provider documentation * Improve provider documentation
1 parent 23cbb46 commit 32c90b7

File tree

6 files changed

+746
-5
lines changed

6 files changed

+746
-5
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919

2020
The Terraform provider for [CloudConnexa](https://openvpn.net/cloud-vpn/?utm_source=terraform&utm_medium=docs) allows teams to configure and update CloudConnexa project parameters via their command line.
2121

22+
## Guides
23+
24+
- [Migration from v0.X.X to v1.0.0](https://registry.terraform.io/providers/OpenVPN/cloudconnexa/latest/docs/guides/migration-to-v1)
25+
2226
## Maintainers
2327

2428
This provider plugin is maintained by:
Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1-
# Terraform v1.0.0 migration guide
1+
---
2+
page_title: "Upgrading to version 1 (from 0.x)"
3+
description: Terraform CloudConnexa Provider Version 1 Upgrade Guide
4+
---
25

3-
Important: this migration guide is created to outline migration from older versions of Terraform provider (which where using "/beta" endpoint) to Terraform provider v1.0.0 (which is using "/v1" endpoint).
6+
# Terraform CloudConnexa Provider Version 1 Upgrade Guide
47

5-
In v1.0.0 we intruduced BREAKING CHANGES, which we will cover in this migration guide.
8+
This migration guide is created to outline migration from older versions of Terraform provider (which where using "/beta" endpoint) to Terraform provider v1.0.0 (which is using "/v1" endpoint).
9+
10+
Version 1 of the CloudConnexa Terraform Provider is introducing several BREAKING CHANGES, which we will cover in this migration guide.
611

712
## 1/ Data sources will use only "id" field
813

docs/index.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,53 @@
11
---
2-
# generated by https://github.com/hashicorp/terraform-plugin-docs
32
page_title: "cloudconnexa Provider"
43
subcategory: ""
54
description: |-
6-
5+
The CloudConnexa provider provides resources to interact with the CloudConnexa API.
76
---
87

98
# cloudconnexa Provider
109

10+
Use this provider to interact with the [CloudConnexa API](https://openvpn.net/cloud-docs/developer/index.html).
11+
The provider needs to be configured with the proper credentials before it can be used.
1112

13+
## Credentials
1214

15+
To authenticate with the CloudConnexa API, you'll need the client_id and client_secret.
16+
These credentials can be found in the CloudConnexa Portal.
1317

18+
Go to the Settings page and click on the API tab.
19+
From there, you can enable the API and generate new authentication credentials.
20+
Additionally, you'll find Swagger documentation for the API in the same location.
21+
22+
More documentation on the CloudConnexa API credentials can be found here:
23+
[Creating API credentials](https://openvpn.net/cloud-docs/developer/creating-api-credentials.html)
24+
25+
!> **Warning:** Hard-coded credentials are not recommended in any Terraform
26+
configuration and risks secret leakage should this file ever be committed to a
27+
public version control system.
28+
29+
## Example Usage
30+
31+
```terraform
32+
terraform {
33+
required_providers {
34+
cloudconnexa = {
35+
source = "OpenVPN/cloudconnexa"
36+
version = "~> 1"
37+
}
38+
}
39+
}
40+
41+
provider "cloudconnexa" {
42+
client_id = var.cloudconnexa_client_id
43+
client_secret = var.cloudconnexa_client_secret
44+
}
45+
46+
# Create a User Group
47+
resource "cloudconnexa_user_group" "this" {
48+
# ...
49+
}
50+
```
1451

1552
<!-- schema generated by tfplugindocs -->
1653
## Schema

examples/provider/provider.tf

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
terraform {
2+
required_providers {
3+
cloudconnexa = {
4+
source = "OpenVPN/cloudconnexa"
5+
version = "~> 1"
6+
}
7+
}
8+
}
9+
10+
provider "cloudconnexa" {
11+
client_id = var.cloudconnexa_client_id
12+
client_secret = var.cloudconnexa_client_secret
13+
}
14+
15+
# Create a User Group
16+
resource "cloudconnexa_user_group" "this" {
17+
# ...
18+
}

0 commit comments

Comments
 (0)