chore: root module improvements, prepare repo to make public by billkable · Pull Request #12 · educates/educates-terraform-modules

billkable · 2025-05-28T14:08:24Z

[Update Root Modules to make Educates Platform installation optional #8]
[Make Educates Terraform Modules public for OSS Consumption #9]
add examples of common var configurations, including labels/taints [Add ability to set labels on nodegroups #10]

jorgemoralespou

Left some comments

jorgemoralespou · 2025-05-30T16:24:16Z

CONTRIBUTING.md

+
+If your primary objective is to use Educates, check out the [Educates user documentation](https://docs.educates.dev/).
+
+If you want to contribute changes to Educates, check out the [Educates developer documentation](developer-docs/README.md).


This link will need to be updated to point to educates-training-platform repo

@jorgemoralespou done

jorgemoralespou · 2025-05-30T16:25:05Z

CONTRIBUTING.md

+
+### Pull Request Checklist
+
+1. Ensure that you have not included any personal or company copyright notices in any changes. This project relies on a single copyright assignment in the [NOTICE](NOTICE) file with attribution to "The Educates Authors".


This file does not exist. Does it exist in the original repo? Should this be updated there as well?

@jorgemoralespou the contribution guide is changed to point to Educates Training Portal repo, will file issue there.

jorgemoralespou · 2025-05-30T16:26:34Z

README.md

+If you have some common configurations you want to share,
+[submit a PR](#release-a-module).  We'll review and potentially add it.
+
+## Gitops configuration


Does this rely on the other module to be released?

@jorgemoralespou no. if you read the 2nd section, you'll see implicit TODO.

jorgemoralespou · 2025-05-30T16:28:48Z

root-modules/educates-on-eks/env.template

+# Set the following variables in your shell environment
+export aws_region="AWS_REGION"
+export aws_account_id="AWS_ACCOUNT_ID"
+export iams_principal="IAM_PRINCIPAL"


Looking at this file, I wouldn't know what to put as IAM_PRINCIPAL, and couldn't figure it out looking at the rest of the files in here

@jorgemoralespou documented in README Configuration Examples

jorgemoralespou · 2025-05-30T16:29:40Z

root-modules/educates-on-eks/examples/main.tfvars.example.node-group-profile

+kubernetes_version = "1.32"
+cluster_name = "{{cluster_name}}"
+deploy_educates = true
+educates_version = "3.2.2"


Latest Educates released version to date is 3.3.2

@jorgemoralespou done

jorgemoralespou · 2025-05-30T16:30:38Z

root-modules/educates-on-eks/variables.tf

 # Configuration for the Educates Installer
 ##
+variable "deploy_educates" {
+  description = "Whether to enable and install Educates platform"


Description does not match name. I would change it to: "Whether to deploy/install Educates platform onto the cluster"

@jorgemoralespou done

jorgemoralespou · 2025-05-30T16:30:57Z

root-modules/educates-on-gke/examples/main.tfvars.example

+kubernetes_version = "1.32"
+cluster_name = "{{cluster_name}}"
+deploy_educates = true
+educates_version = "3.2.2"


Same as before

@jorgemoralespou done

jorgemoralespou · 2025-05-30T16:31:13Z

root-modules/educates-on-gke/variables.tf

 # Configuration for the Educates Installer
 ##
+variable "deploy_educates" {
+  description = "Whether to enable and install Educates platform"


Same as before

@jorgemoralespou done

jorgemoralespou · 2025-05-30T16:33:12Z

root-modules/scripts/make-vars.sh

What is the purpose of this script file? Since it's not easy to grok, I would add some comment explaining the file, and potentially a README.md somewhere at the root-modules folder level

@jorgemoralespou script and env.template files removed - see readme configuration section where configuration parameters are documented.

billkable · 2025-06-02T16:46:12Z

Per discussion with @jorgemoralespou, will remove the template/script, but will document the placeholder variables.

jorgemoralespou

There's still 3.2.2 references instead of 3.3.2, but I'm ok if you want to merge like this, otherwise do a global find/replace of 3.2.2 with 3.3.2 and we should be ok to go.

jorgemoralespou · 2025-06-04T11:42:07Z

root-modules/educates-on-eks/examples/main.tfvars.example

+kubernetes_version = "1.32"
+cluster_name = "{{cluster_name}}"
+deploy_educates = true
+educates_version = "3.2.2"


Still 3.2.2

jorgemoralespou · 2025-06-04T11:42:43Z

root-modules/educates-on-gke/examples/main.tfvars.example

+kubernetes_version = "1.32"
+cluster_name = "{{cluster_name}}"
+deploy_educates = true
+educates_version = "3.2.2"


Still 3.2.2

jorgemoralespou · 2025-06-04T11:42:55Z

root-modules/educates-on-gke/examples/main.tfvars.example.node-pool-profile

+kubernetes_version = "1.32"
+cluster_name = "{{cluster_name}}"
+deploy_educates = true
+educates_version = "3.2.2"


Still 3.2.2

jorgemoralespou · 2025-06-04T11:43:31Z

root-modules/educates-on-gke/examples/main.tfvars.example.spring-web-workload

+kubernetes_version = "1.32"
+cluster_name = "{{cluster_name}}"
+deploy_educates = true
+educates_version = "3.2.2"


Still 3.2.2

Do a global find/replace of 3.2.2 with 3.3.2 and we should be ok to go.

@jorgemoralespou done

github-actions · 2025-06-04T14:05:20Z

Release Plan

Module	Release Type	Latest Version	New Version
`platform/educates`	patch	v1.0.1	v1.0.2

🚫 Wiki Check: Generation is disabled.

Changelog

`platform/educates/v1.0.2` (2025-06-04)

🔀PR #12 - chore: root module improvements, prepare repo to make public

_{Powered by techpivot/terraform-module-releaser}

billkable · 2025-06-04T14:06:27Z

@jorgemoralespou I think we are good. the topic branch is fixed up, should be ready to merge.

github-actions · 2025-06-04T14:08:13Z

🚀 Terraform Module Releases

The following Terraform modules have been released:

platform/educates/v1.0.2 • Release Notes

_{Powered by techpivot/terraform-module-releaser}

billkable requested a review from jorgemoralespou May 28, 2025 14:08

billkable force-pushed the root-module-improvements branch from 5cdb712 to 277faa7 Compare May 28, 2025 18:00

jorgemoralespou requested changes May 30, 2025

View reviewed changes

billkable force-pushed the root-module-improvements branch 2 times, most recently from 5e1ec8c to fd2951d Compare June 3, 2025 17:19

jorgemoralespou approved these changes Jun 4, 2025

View reviewed changes

chore: root module improvements, prepare repo to make public

903c452

billkable force-pushed the root-module-improvements branch from 2aa60d9 to 903c452 Compare June 4, 2025 14:05

jorgemoralespou merged commit 037b9c2 into main Jun 4, 2025
1 check passed

jorgemoralespou deleted the root-module-improvements branch June 4, 2025 14:08

billkable mentioned this pull request Jun 5, 2025

Update Root Modules to make Educates Platform installation optional #8

Closed


		If your primary objective is to use Educates, check out the [Educates user documentation](https://docs.educates.dev/).

		If you want to contribute changes to Educates, check out the [Educates developer documentation](developer-docs/README.md).


		### Pull Request Checklist

		1. Ensure that you have not included any personal or company copyright notices in any changes. This project relies on a single copyright assignment in the [NOTICE](NOTICE) file with attribution to "The Educates Authors".

Conversation

billkable commented May 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jorgemoralespou left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

billkable commented Jun 2, 2025

Uh oh!

jorgemoralespou left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 4, 2025

Release Plan

🚫 Wiki Check: Generation is disabled.

Changelog

platform/educates/v1.0.2 (2025-06-04)

Powered by techpivot/terraform-module-releaser

Uh oh!

billkable commented Jun 4, 2025

Uh oh!

Uh oh!

github-actions bot commented Jun 4, 2025

🚀 Terraform Module Releases

Powered by techpivot/terraform-module-releaser

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

billkable commented May 28, 2025 •

edited

Loading

`platform/educates/v1.0.2` (2025-06-04)

_{Powered by techpivot/terraform-module-releaser}

_{Powered by techpivot/terraform-module-releaser}