Skip to content

Conversation

@P-rple
Copy link
Contributor

@P-rple P-rple commented Dec 31, 2024

Overview of Changes

General overview of what has been changed

Added Terraform documentation.

Reason for Modification

This section will list the reasons modification were preformed. This justifies why the changes are necessary or the documentation should be added.

Verification

  • [x ] The documentation is completed, or does not contain work-in-progress/partially-completed sections.
  • [x ] The documentation is written in Markdown (Exception for Inject and Incident Reports).
  • [x ] Any Images are contained in a subdirectory Images.
  • [x ] Any scripts, Ansible Playbooks, Terraform scripts, etc. Have documentation explaining their purpose and use case.
  • [x ] Any scripts are tested.
  • I have assigned and notified a reviewer.

@P-rple P-rple requested a review from a team as a code owner December 31, 2024 01:01
Copy link
Contributor

@DaintyJet DaintyJet left a comment

Choose a reason for hiding this comment

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

Decent start, there are some formatting issues and sections should probably be re-worded or additional info added.

* Audit the DNS Server each machine is configured to use (/etc/resolv.conf, nmtui)
* Can Wazuh do this? What about Zabbix
* Is DNSSec something that is good
* Question(Need to look into): Is DNSSec something that is good?
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably want to separate out any cleanup things like this into a separate pull request just to make sure things are more streamlined and clean. Its fine for this one, but something to keep in mind for the future.

I do this type of thing too. I am trying to get better...

@@ -0,0 +1,93 @@
# About
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably want to make the title of the document more descriptive with the following section being an implicit about section for the document.

@@ -0,0 +1,93 @@
# About
This a helpfile listing the components used in the creation of a teraform based infrastructure. This uses aws-provider based examples, but are general to any terraform provider. This is organized into 2 groups, components & files.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is different from the name of the document, which includes help-commands where it is more of an broader introduction?

Also Terraform is spelled incorrectly and should be capitalized.

# About
This a helpfile listing the components used in the creation of a teraform based infrastructure. This uses aws-provider based examples, but are general to any terraform provider. This is organized into 2 groups, components & files.

*Of course, this is not every single aspect of terraform, but should be a decent start to creating a full terraform-based infrastructure*
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
*Of course, this is not every single aspect of terraform, but should be a decent start to creating a full terraform-based infrastructure*
> [!NOTE]
> This is not every aspect of terraform, but should provide a decent starting point in the creation of a full terraform-based infrastructure



## Components
### Providers:
Copy link
Contributor

Choose a reason for hiding this comment

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

Some sections have the : while others do not. I prefer not using them vs using them.


Create a main.tf file. Convention is to name the file "main.tf"

This is where the block of the cofiguration for the virtual machines will be deployed
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This is where the block of the cofiguration for the virtual machines will be deployed
This is where the block of the configuration for the virtual machines will be deployed

```

## Initialize Terraform
1. Intialize terraform
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Intialize terraform
1. Initialize terraform

## Delete resources using terraform destroy
```sh
terraform destory
Copy link
Contributor

Choose a reason for hiding this comment

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

I think destroy is spelled wrong

Show issues regarding your terraform file

```sh
terraform plan`
Copy link
Contributor

Choose a reason for hiding this comment

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

There is an extra `?

```


## Run terraform plan
Copy link
Contributor

Choose a reason for hiding this comment

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

This section is tabbed in too much making it into a code block

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants