Tes 234 improve documentation #16

kristianiliev1 · 2023-10-17T07:52:23Z

Description

Added initial description for all modules and main readme.md

Related Issues

https://ontotext.atlassian.net/browse/TES-234

Changes

Added All README.md files for Modules and main description

Screenshots (if applicable)

N/A

Checklist

I have tested these changes thoroughly.
My code follows the project's coding style.
I have added appropriate comments to my code, especially in complex areas.
All new and existing tests passed locally.

Reviewers:

@yaskoo @mihailradkov Please review this PR

Initial description add to README.md - How to use and what it is.

Initial add documentation for Backup Module

Initial description add for config module

Initial description add for DNS module

Initial description add for IAM module

Initial description add for load balancer module

Initial description add for user_data module

Initial description add for vm module

Add Hyperlinks to "Modules"

Add 1 more hyperlink

kristianiliev1

Test @

mihailradkov · 2023-10-20T08:36:14Z

README.md

@@ -1,15 +1,195 @@
-# GraphDB AWS Terraform Module
+# Terraform AWS GraphDB Module


IMO the previous sounded better.

mihailradkov · 2023-10-20T08:37:10Z

README.md


-TBD: Intro
+This Terraform module allows you to provision an AWS GraphDB cluster within a Virtual Private Cloud (VPC) in AWS. The module provides a flexible way to configure the cluster and the associated VPC components.


Try to limit the AWS reference, e.g.

This Terraform module allows you to provision a GraphDB cluster within a Virtual Private Cloud (VPC) in AWS. The module provides a flexible way to configure the cluster and the associated VPC components.

mihailradkov · 2023-10-20T08:40:52Z

README.md


-Check out the contributors guide [CONTRIBUTING.md](CONTRIBUTING.md).
+This README provides more detailed information about the important variables and how to configure them for the Terraform AWS GraphDB module. Please ensure that you adapt the configuration to match your specific use case and requirements.


I think this is lost here at the bottom, maybe move it somewhere in the configurations sections ?

mihailradkov · 2023-10-20T08:41:47Z

README.md

+
+TODO MORE
+
+### Example Configuration


Could be moved as an example under examples/ or simply refer to the one that we already have.

mihailradkov · 2023-10-20T08:42:44Z

README.md

+   # Configure the required variables for the module.
+   ```
+
+


Avoid adding exessive/useless empty lines.

mihailradkov · 2023-10-20T08:43:18Z

README.md

+
+- `security_group_ids`: A list of security group IDs to associate with the instances for network security.
+
+TODO MORE


Either finish this or submit a task.

TES-234

yaskoo · 2023-10-20T12:41:25Z

README.md

+—
+## Prerequisites
+
+Before you begin using this Terraform module, ensure you have the following prerequisites:


Suggested change

Before you begin using this Terraform module, ensure you have the following prerequisites:

Before you begin using this Terraform module, ensure you meet the following prerequisites:

README.md

yaskoo · 2023-10-20T12:49:05Z

README.md

+  ```shell
+    terraform apply
+  ```
+


Unnecessary empty lines.

README.md

Changed the Documentation according Yasen's comments. TES-234

yaskoo · 2023-10-23T13:41:20Z

README.md

+
+- `instance_type`: The instance type for the GDB cluster nodes. This should match your performance and cost requirements.
+
+- `cluster_size`: The number of instances in the cluster. Recommended is 3, 5 or 7 in order to have consensus according to the [RAFT algorithm](https://raft.github.io/). 


Do we have a cluster_size variable?
Also, write Raft and not RAFT - it's not an abbreviation.

yaskoo · 2023-10-23T13:44:00Z

README.md

+
+- `subnet_ids`: A list of subnet IDs in your VPC to place the Neptune instances. Ensure that these subnets have proper route tables and security groups configured.
+
+- `security_group_ids`: A list of security group IDs to associate with the instances for network security.


I don't believe we have this variable as well.

yaskoo · 2023-10-23T13:45:24Z

README.md

+
+ami_id = "GraphDB-AMI"
+
+instance_type = "instance type"


Add real instance type or remove to use the default.

yaskoo · 2023-10-23T13:46:05Z

README.md

+
+instance_type = "instance type"
+
+graphdb_version = "10.4.0"


Remove this. Tomorrow this is going to be 10.4.1 and we don't want users deploying it after 2 years :D

README.md

yaskoo · 2023-10-23T13:50:25Z

README.md

@@ -1,15 +1,117 @@
 # GraphDB AWS Terraform Module

-TBD: Intro
+This Terraform module allows you to provision an GraphDB cluster within a Virtual Private Cloud (VPC). The module provides a flexible way to configure the cluster and the associated VPC components.


We could mention that this module "Implements the GraphDB reference architecture on AWS" - https://graphdb.ontotext.com/documentation/10.4/aws-deployment.html

TES-234

Added a suggested link to Documentation by Yasen TES-234

yaskoo

@mihailradkov do you have anything else we need to address here?

yaskoo · 2023-10-31T14:09:13Z

Update the branch before merging.

kristianiliev1 added 10 commits October 17, 2023 10:34

Update README.md

de7fc38

Initial description add to README.md - How to use and what it is.

Update README.md

72f860d

Initial add documentation for Backup Module

Update README.md

eb3ed8a

Initial description add for config module

Update README.md

bccbc96

Initial description add for DNS module

Update README.md

0960031

Initial description add for IAM module

Update README.md

097450f

Initial description add for load balancer module

Update README.md

95accb4

Initial description add for user_data module

Update README.md

d9aacca

Initial description add for vm module

Update README.md

6e5e111

Add Hyperlinks to "Modules"

Update README.md

e540711

Add 1 more hyperlink

kristianiliev1 marked this pull request as draft October 17, 2023 08:31

kristianiliev1 marked this pull request as ready for review October 17, 2023 08:42

kristianiliev1 commented Oct 17, 2023

View reviewed changes

yaskoo requested review from mihailradkov and yaskoo October 17, 2023 10:12

mihailradkov reviewed Oct 20, 2023

View reviewed changes

Fixed some suggestions by Mihail

951caa6

TES-234

yaskoo reviewed Oct 20, 2023

View reviewed changes

Change Documentation

5b8d2dd

Changed the Documentation according Yasen's comments. TES-234

yaskoo reviewed Oct 23, 2023

View reviewed changes

kristianiliev1 added 2 commits October 23, 2023 14:44

Fixed suggestions by Yasen

7612445

TES-234

Add Documentation link

e14abc4

Added a suggested link to Documentation by Yasen TES-234

yaskoo approved these changes Oct 31, 2023

View reviewed changes

Merge branch 'main' into TES-234-Improve-Documentation

4a7cfcc

kristianiliev1 merged commit 04ecfae into Ontotext-AD:main Oct 31, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tes 234 improve documentation #16

Tes 234 improve documentation #16

kristianiliev1 commented Oct 17, 2023 •

edited

Loading

kristianiliev1 left a comment •

edited

Loading

mihailradkov Oct 20, 2023

mihailradkov Oct 20, 2023

mihailradkov Oct 20, 2023

mihailradkov Oct 20, 2023

mihailradkov Oct 20, 2023

mihailradkov Oct 20, 2023

yaskoo Oct 20, 2023

yaskoo Oct 20, 2023

yaskoo Oct 23, 2023

yaskoo Oct 23, 2023

yaskoo Oct 23, 2023

yaskoo Oct 23, 2023

yaskoo Oct 23, 2023

yaskoo left a comment

yaskoo commented Oct 31, 2023

		@@ -1,15 +1,195 @@
		# GraphDB AWS Terraform Module
		# Terraform AWS GraphDB Module


		TBD: Intro
		This Terraform module allows you to provision an AWS GraphDB cluster within a Virtual Private Cloud (VPC) in AWS. The module provides a flexible way to configure the cluster and the associated VPC components.


		Check out the contributors guide [CONTRIBUTING.md](CONTRIBUTING.md).
		This README provides more detailed information about the important variables and how to configure them for the Terraform AWS GraphDB module. Please ensure that you adapt the configuration to match your specific use case and requirements.


		- `security_group_ids`: A list of security group IDs to associate with the instances for network security.

		TODO MORE

	Before you begin using this Terraform module, ensure you have the following prerequisites:
	Before you begin using this Terraform module, ensure you meet the following prerequisites:


		- `instance_type`: The instance type for the GDB cluster nodes. This should match your performance and cost requirements.

		- `cluster_size`: The number of instances in the cluster. Recommended is 3, 5 or 7 in order to have consensus according to the [RAFT algorithm](https://raft.github.io/).


		- `subnet_ids`: A list of subnet IDs in your VPC to place the Neptune instances. Ensure that these subnets have proper route tables and security groups configured.

		- `security_group_ids`: A list of security group IDs to associate with the instances for network security.

Tes 234 improve documentation #16

Tes 234 improve documentation #16

Conversation

kristianiliev1 commented Oct 17, 2023 • edited Loading

Description

Related Issues

Changes

Screenshots (if applicable)

Checklist

Reviewers:

kristianiliev1 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yaskoo left a comment

Choose a reason for hiding this comment

yaskoo commented Oct 31, 2023

kristianiliev1 commented Oct 17, 2023 •

edited

Loading

kristianiliev1 left a comment •

edited

Loading