Skip to content
This repository has been archived by the owner on Aug 18, 2023. It is now read-only.

Update Documentation #22

Merged
merged 4 commits into from
Jul 9, 2020
Merged

Conversation

krishvoor
Copy link
Contributor

This PR Aims at providing a fix for #6 by updating the relevant Documentation.

krishvoor added 2 commits July 7, 2020 15:30
This MarkDown file provides instructions on how to build terraform providers before performing
terraform init & apply subsequently.
Added Terraform Providers sub-section under Pre-requisites.
README.md Outdated
@@ -22,6 +22,7 @@ Run this code from either Mac or Linux (Intel) system.
- **Git**: Please refer to the following [link](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) for instructions
on installing `git` for Linux and Mac.
- **Terraform**: You'll need to use version `0.12.20`. Please refer to the following [link](https://learn.hashicorp.com/terraform/getting-started/install.html) for instructions on installing `terraform` for Linux and Mac.
- **Terraform Providers**: Please ensure terraform providers are built and installed on KVM host. You can follow the [Build Terraform Providers](docs/terraform-provider-build.md) guide.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

KVM host -> Terraform client machine

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

# Steps to build terraform providers

Follow below steps to setup terraform providers. These steps are required to be followed before running the automation.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A note to follow below sections depending on the client arch would help.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated documentation to emphasize the steps required to be followed based on Terraform Client Machine Architecture.

krishvoor added 2 commits July 7, 2020 17:01
Updated KVM Host --> Terraform Client Machine
Updated Markdown file to emphasize steps to be followed based on Terraform Client Machine Architecture
Copy link
Collaborator

@yussufsh yussufsh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yussufsh yussufsh requested a review from bpradipt July 7, 2020 13:55
Copy link
Contributor

@bpradipt bpradipt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm
Thanks @krishvoor

@bpradipt bpradipt merged commit a1b1955 into ocp-power-automation:master Jul 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants