Add documentation (#10)

spectrocloud · Dec 31, 2020 · a3a4608 · a3a4608
1 parent 925ac6c
commit a3a4608
Show file tree

Hide file tree

Showing 2 changed files with 74 additions and 2 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -7,11 +7,26 @@ description: |-
 
 # Spectro Cloud Provider
 
+The Spectro Cloud provider provides resources to interact with Spectro Cloud management API (SaaS or on-prem).
 
-The Spectro Cloud provider provides resources to interact with Spectro Cloud management API (SaaS or on-prem). Review the examples.
+## What is Spectro Cloud?
+
+The Spectro Cloud management platform brings the managed Kubernetes experience to users' own unique enterprise
+Kubernetes infrastructure stacks running in any public cloud, or private cloud environments, allowing users to
+not have to trade-off between flexibility and manageability. Spectro Cloud provides an as-a-service experience
+to users by automating the lifecycle of multiple Kubernetes clusters based on user-defined Kubernetes
+infrastructure stacks.
+
+## Spectro Cloud account
+
+This provider requires access to a valid Spectro Cloud account. 
+
+If you haven't already, please signup for a free Spectro Cloud account here: [Spectro Cloud Signup](https://www.spectrocloud.com/free-trial/).
 
 ## Example Usage
 
+Create a `providers.tf` file with the following 
+
 ```terraform
 terraform {
   required_providers {
@@ -30,6 +45,24 @@ provider "spectrocloud" {
 }
 ```
 
+Create or append to a `terraform.tfvars` file:
+
+```terraform
+# Credentials
+host         = "console.spectrocloud.com"
+username     = "[email protected]" # Username of the user (or specify with SPECTROCLOUD_USERNAME env var)
+password     = "superSecure1!" # Password of the user (or specify with SPECTROCLOUD_PASSWORD env var)
+project_name = "Default"       # Project name (e.g: Default)
+```
+
+-> Be sure to populate the `username`, `password`, and other terraform vars.
+
+
+Next, initialize terraform using:
+
+    terraform init
+
+
 ## Schema
 
 ### Required

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -7,11 +7,50 @@ description: |-
 
 # Spectro Cloud Provider
 
+The Spectro Cloud provider provides resources to interact with Spectro Cloud management API (SaaS or on-prem).
 
-The Spectro Cloud provider provides resources to interact with Spectro Cloud management API (SaaS or on-prem). Review the examples.
+## What is Spectro Cloud?
+
+The Spectro Cloud management platform brings the managed Kubernetes experience to users' own unique enterprise
+Kubernetes infrastructure stacks running in any public cloud, or private cloud environments, allowing users to
+not have to trade-off between flexibility and manageability. Spectro Cloud provides an as-a-service experience
+to users by automating the lifecycle of multiple Kubernetes clusters based on user-defined Kubernetes
+infrastructure stacks.
+
+## Spectro Cloud account
+
+This provider requires access to a valid Spectro Cloud account.
+
+If you haven't already, please signup for a free Spectro Cloud account here: [Spectro Cloud Signup](https://www.spectrocloud.com/free-trial/).
 
 ## Example Usage
 
+Create a `providers.tf` file with the following:
+
 {{tffile "examples/provider/provider.tf"}}
 
+Create or append to a `terraform.tfvars` file:
+
+{{tffile "examples/provider/terraform.tfvars"}}
+
+->
+Be sure to populate the `username`, `password`, and other terraform vars.
+
+Ok
+
+-> Be sure to populate the `username`, `password`, and other terraform vars.
+
+Next, run terraform using:
+
+    terraform init && terraform apply
+
+Detailed schema definitions for each resource are listed in the _Resources_ menu on the left.
+
+For an end-to-end example of provisioning Spectro Cloud resources, visit: [...](https://github.com).
+
+## Support
+
+For questions or issues with the provider, please report them as issues on 
+[Spectro Cloud provider](https://github.com/spectrocloud/terraform-provider-spectrocloud/issues).
+
 {{ .SchemaMarkdown | trimspace }}