updated usage documentation

jeanmichelaudet · Jun 7, 2022 · 81938b7 · 81938b7
1 parent cf97c84
commit 81938b7
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 0 deletions.
diff --git a/PROVIDER_USAGE.md b/PROVIDER_USAGE.md
@@ -0,0 +1,34 @@
+# Provider Usage
+
+## Build the provider
+
+Refer [README.md](./README.md)'s Build the provider section
+
+## Authentication
+
+### Get API Access
+
+> You should have API access to the Citrix ADM Service. Below are the steps to get the API access.
+
+1. ![Step 1](./media/adm-service-authentication/1.png)
+2. ![Step 2](./media/adm-service-authentication/2.png)
+3. ![Step 3](./media/adm-service-authentication/3.png)
+
+> By the above steps, you should have got `customer_id`, `client_id` and `client_secret` for the API access.
+
+### Configure the provider
+
+1. Go to the respective example folder in the [examples](./examples) folder.
+   Eg: Let's assume you need to crate a NS DEVICE PROFILE
+
+   ```sh
+   cd examples/resources/citrixadm_ns_device_profile
+   ```
+
+2. Configure the `provider.tf` file - There are two ways
+   1. Provide `host`, `host_location`, `customer_id`, `client_id` and `client_secret` in the `provider.tf` file, OR
+   2. Have the respective ENVIRNMENT variables set: `CITRIXADM_HOST`, `CITRIXADM_HOST_LOCATION`, `CITRIXADM_CUSTOMER_ID`, `CITRIXADM_CLIENT_ID` and `CITRIXADM_CLIENT_SECRET`
+
+3. Run the `terraform init` command.
+4. Run the `terraform plan` command.
+5. Run the `terraform apply` command. (If you want to destroy the resource, run `terraform destroy` command).
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# Terraform `Citrix ADM Service` Provider
+
+- Website: https://www.terraform.io
+
+## Requirements
+
+- [Terraform](https://www.terraform.io/downloads.html) 1.0.x
+- [Go](https://golang.org/doc/install) 1.11 (to build the provider plugin)
+
+## Building The Provider
+
+> In [Makefile](./Makefile) Change the `OS_ARCH` variable to the architecture of your system.
+> For Eg: `OS_ARCH=linux_amd64` OR `OS_ARCH=darwin_amd64` OR `OS_ARCH=windows_amd64`
+
+```sh
+git clone [email protected]:citrix/terraform-provider-citrixadc
+cd terraform-provider-citrixadc
+make
+```
+
+## Using the provider
+
+Documentation can be found [here](./PROVIDER_USAGE.md).
diff --git a/media/adm-service-authentication/1.png b/media/adm-service-authentication/1.png
diff --git a/media/adm-service-authentication/2.png b/media/adm-service-authentication/2.png
diff --git a/media/adm-service-authentication/3.png b/media/adm-service-authentication/3.png