Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add initial documentation for each of the modules #6

Merged
merged 21 commits into from
May 14, 2024

Conversation

ppawlowski
Copy link
Contributor

@ppawlowski ppawlowski commented May 14, 2024

Description

This pull request adds module documentation for the eks, lb-domain, rds, route53, ses, vpc, and vpc-peering modules. The documentation includes descriptions of the resources used in each module and example usage. Additionally, the main readme file now includes links to the documentation of each module.

Additionally, this PR removes unused variables from the EKS module.

Related Issue(s)

#5

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production

Labels

  • Includes a DB migration? -> add the area:migration label

@ppawlowski ppawlowski requested a review from hardillb May 14, 2024 12:15
@ppawlowski ppawlowski linked an issue May 14, 2024 that may be closed by this pull request
default = "1.26"
type = string
description = "The desired Kubernetes master version. If you do not specify a value, the latest available version is used."
default = "1.26"
Copy link
Contributor

Choose a reason for hiding this comment

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

Not suggesting we change this at the moment, just wondering if something new would be better as we hope to move prod to 1.26 soon, but irrc this only has a short support life on AWS

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I picked up this version since I recall you were locally running FF on this version without issues.
My approach here is to change the default value once we confirm internally that there are no issues with FF on specific Kubernetes version.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hardillb in fact, if we can somehow confirm FF compatibility with a higher Kubernetes version then I am fine with setting a different default version.

Copy link
Contributor

Choose a reason for hiding this comment

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

The test "scaling" cluster is currently running 1.26 and I think that is newest we have actually tested recently.

My cluster is running 1.24 and needs upgrading. Leave this as it is for now, but we should open a ticket in CloudProject to upgrade the scaling cluster as a test and then update.

Copy link
Contributor

@hardillb hardillb left a comment

Choose a reason for hiding this comment

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

Approved but not merged, please check my comment about the K8s version

@ppawlowski ppawlowski merged commit ad04fb4 into main May 14, 2024
@ppawlowski ppawlowski deleted the docs-initial branch May 14, 2024 13:44
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.

Add simple documentation for each of the terraform modules
2 participants