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

feat: Update Wireguard example to new layout #1761

Merged
merged 3 commits into from
Oct 5, 2023
Merged

Conversation

bryantbiggs
Copy link
Contributor

Description

  • Update Wireguard example to new layout; this is open for discussion - see motivation below
    • Since this is no longer a module, we do not have to follow the norms and conventions of a module (i.e. - variables.tf, outputs.tf, etc.). We are free to create the file naming and directory structure that makes it easier for users to discover and reach the information they are seeking
    • The sample resources were converted to use the Kubernetes provider to reduce our reliance on the kubectl provider which appears to have become defunct; this also removes the boilerplate of yet one more provider in the pattern. These resources are defined in sample.tf to make it clear this is not required by the pattern and can be removed/ignored
    • The EKS and Cilium resources were moved to eks.tf - this is the heart of where users should look when viewing code and this is highlighted in the docs new section Areas of Interest (this phrasing is open to change - I'm not super thrilled with it currently but the point still stands - "Look here for whats notable in this pattern")

Motivation and Context

  • The goal of this proposed change is to de-emphasize the boilerplate and supporting resources required for a stable pattern that is deployable, while emphasizing and highlighting the components that are notable and of interest for a pattern
    • Does this do that? Are there ways to improve on this?

How was this change tested?

  • Yes, I have tested the PR using my local account setup (Provide any test evidence report under Additional Notes)
  • Yes, I have updated the docs for this feature
  • Yes, I ran pre-commit run -a with this PR

Additional Notes

  • I have deployed and validated the example and updated the docs to reflect additional tests provided by the Cilium project

@bryantbiggs bryantbiggs requested a review from a team as a code owner September 12, 2023 21:15
Copy link
Contributor

@askulkarni2 askulkarni2 left a comment

Choose a reason for hiding this comment

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

🚀

patterns/wireguard-with-cilium/README.md Outdated Show resolved Hide resolved
@bryantbiggs bryantbiggs temporarily deployed to EKS Blueprints Test October 4, 2023 20:42 — with GitHub Actions Inactive
Copy link
Contributor

@askulkarni2 askulkarni2 left a comment

Choose a reason for hiding this comment

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

LGTM!

@askulkarni2 askulkarni2 merged commit 5fd82f3 into main Oct 5, 2023
56 checks passed
@askulkarni2 askulkarni2 deleted the feat/example-update branch October 5, 2023 18:09
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.

3 participants