-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
729e826
commit b6699e5
Showing
23 changed files
with
764 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Code Owners | ||
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners | ||
|
||
* @osinfra-sa |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Dependabot | ||
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: github-actions | ||
|
||
# NOTE: The "/" here is for checking for workflow files in .github/workflows | ||
|
||
directory: / | ||
schedule: | ||
interval: daily |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: Add To GitHub Projects | ||
|
||
on: | ||
issues: | ||
types: | ||
- opened | ||
pull_request: | ||
types: | ||
- opened | ||
|
||
permissions: | ||
issues: write | ||
|
||
jobs: | ||
add-to-osinfra-project: | ||
name: Open Source Infrastructure (as Code) | ||
uses: osinfra-io/github-misc-called-workflows/.github/workflows/add-to-project.yml@v0.1.6 | ||
with: | ||
project_id: 1 | ||
secrets: | ||
add_to_project_pat: ${{ secrets.ADD_TO_PROJECT_PAT }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
name: Dependabot Approve and Merge | ||
|
||
on: pull_request_target | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
dependabot: | ||
name: Dependabot | ||
uses: osinfra-io/github-misc-called-workflows/.github/workflows/dependabot.yml@v0.1.6 | ||
secrets: | ||
pr_approve_and_merge_pat: ${{ secrets.PR_APPROVE_AND_MERGE_PAT }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
name: Terraform Tests | ||
|
||
on: | ||
workflow_dispatch: | ||
pull_request: | ||
types: | ||
- opened | ||
- synchronize | ||
paths-ignore: | ||
- "**.md" | ||
|
||
permissions: | ||
id-token: write | ||
|
||
jobs: | ||
tests: | ||
name: Tests | ||
uses: osinfra-io/github-terraform-gcp-called-workflows/.github/workflows/test.yml@v0.2.5 | ||
if: github.actor != 'dependabot[bot]' | ||
with: | ||
service_account: plt-lz-testing-github@ptl-lz-terraform-tf91-sb.iam.gserviceaccount.com | ||
terraform_version: ${{ vars.TERRAFORM_VERSION }} | ||
workload_identity_provider: projects/746490462722/locations/global/workloadIdentityPools/github-actions/providers/github-actions-oidc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# .gitignore | ||
# https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files | ||
|
||
# Local .terraform directories | ||
**/.terraform/* | ||
|
||
# .tfstate files | ||
*.tfstate | ||
*.tfstate.* | ||
|
||
# Crash log files | ||
crash.log | ||
|
||
# Ignore provider lock file | ||
.terraform.lock.hcl | ||
|
||
# Ignore any local.tfvars. Most .tfvars files are managed as part of configuration and so should | ||
# be included in version control. | ||
local.tfvars | ||
|
||
# Provider.tf is used for local development of modules and shouldn't be added to repos. | ||
provider.tf | ||
|
||
# Ignore override files as they are usually used to override ressources locally | ||
override.tf | ||
override.tf.json | ||
*_override.tf | ||
*_override.tf.json | ||
|
||
# Ignore plan output files | ||
plan.out | ||
|
||
# Ignore Infracost directories and files | ||
.infracost | ||
|
||
# Other Files | ||
*.log | ||
*.bak | ||
*.swp | ||
*.tmp | ||
*.gz | ||
*.tgz | ||
*.tar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Pre-commit | ||
# https://github.com/pre-commit/pre-commit | ||
|
||
repos: | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v4.6.0 | ||
hooks: | ||
- id: check-yaml | ||
- id: end-of-file-fixer | ||
- id: trailing-whitespace | ||
- id: check-symlinks | ||
|
||
- repo: https://github.com/antonbabenko/pre-commit-terraform | ||
rev: v1.96.1 | ||
hooks: | ||
- id: terraform_fmt | ||
|
||
# To speed up local validation add the following to your ~/.zshrc: | ||
# export TF_PLUGIN_CACHE_DIR=$HOME/.terraform.d/plugin-cache | ||
|
||
- id: terraform_validate | ||
args: | ||
- --hook-config=--retry-once-with-cleanup=true | ||
- --tf-init-args=-upgrade | ||
exclude: tests/fixtures/shared | ||
|
||
# Always run after terraform_validate | ||
|
||
- id: terraform_docs | ||
|
||
- repo: https://github.com/bridgecrewio/checkov.git | ||
rev: 3.2.255 | ||
hooks: | ||
- id: checkov | ||
verbose: true | ||
args: | ||
- --quiet |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Terraform Docs | ||
# https://github.com/terraform-docs/terraform-docs | ||
|
||
settings: | ||
indent: 3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
# <img align="left" width="45" height="45" src="https://github.com/user-attachments/assets/ce1fe535-f4f3-451f-bbd9-45fde04c000c"> Kubernetes - cert-manager Terraform Module | ||
|
||
**[GitHub Actions](https://github.com/osinfra-io/terraform-kubernetes-cert-manager/actions):** | ||
|
||
[![Terraform Tests](https://github.com/osinfra-io/terraform-kubernetes-cert-manager/actions/workflows/test.yml/badge.svg)](https://github.com/osinfra-io/terraform-kubernetes-cert-manager/actions/workflows/test.yml) [![Dependabot](https://github.com/osinfra-io/terraform-kubernetes-cert-manager/actions/workflows/dependabot.yml/badge.svg)](https://github.com/osinfra-io/terraform-kubernetes-cert-manager/actions/workflows/dependabot.yml) | ||
|
||
**[Infracost](https://www.infracost.io):** | ||
|
||
[![infracost](https://img.shields.io/endpoint?url=https://dashboard.api.infracost.io/shields/json/cbeecfe3-576f-4553-984c-e451a575ee47/repos/925e2406-d209-4aca-847d-21257bc478a5/branch/72fc4157-6bf8-46c0-9d51-593f3cd5bdef)](https://dashboard.infracost.io/org/osinfra-io/repos/925e2406-d209-4aca-847d-21257bc478a5?tab=settings) | ||
|
||
💵 Monthly estimates based on Infracost baseline costs. | ||
|
||
## Repository Description | ||
|
||
Terraform **example** module for a Google Cloud Platform Kubernetes engine cluster. | ||
|
||
> [!NOTE] | ||
> We do not recommend consuming this module like you might a [public module](https://registry.terraform.io/browse/modules). It is a baseline, something you can fork, potentially maintain, and modify to fit your organization's needs. Using public modules vs. writing your own has various [drivers and trade-offs](https://docs.osinfra.io/fundamentals/architecture-decision-records/adr-0003) that your organization should evaluate. | ||
## 🔩 Usage | ||
|
||
> [!TIP] | ||
> You can check the [tests/fixtures](tests/fixtures) directory for example configurations. These fixtures set up the system for testing by providing all the necessary initial code, thus creating good examples on which to base your configurations. | ||
## <img align="left" width="35" height="35" src="https://github.com/osinfra-io/github-organization-management/assets/1610100/39d6ae3b-ccc2-42db-92f1-276a5bc54e65"> Development | ||
|
||
Our focus is on the core fundamental practice of platform engineering, Infrastructure as Code. | ||
|
||
>Open Source Infrastructure (as Code) is a development model for infrastructure that focuses on open collaboration and applying relative lessons learned from software development practices that organizations can use internally at scale. - [Open Source Infrastructure (as Code)](https://www.osinfra.io) | ||
To avoid slowing down stream-aligned teams, we want to open up the possibility for contributions. The Open Source Infrastructure (as Code) model allows team members external to the platform team to contribute with only a slight increase in cognitive load. This section is for developers who want to contribute to this repository, describing the tools used, the skills, and the knowledge required, along with Terraform documentation. | ||
|
||
See the documentation for setting up a local development environment [here](https://docs.osinfra.io/fundamentals/development-setup). | ||
|
||
### 🛠️ Tools | ||
|
||
- [checkov](https://github.com/bridgecrewio/checkov) | ||
- [helm](https://github.com/helm/helm) | ||
- [infracost](https://github.com/infracost/infracost) | ||
- [pre-commit](https://github.com/pre-commit/pre-commit) | ||
- [pre-commit-terraform](https://github.com/antonbabenko/pre-commit-terraform) | ||
- [terraform-docs](https://github.com/terraform-docs/terraform-docs) | ||
|
||
### 📋 Skills and Knowledge | ||
|
||
Links to documentation and other resources required to develop and iterate in this repository successfully. | ||
|
||
- [cert-manager](https://cert-manager.io/docs) | ||
|
||
### 🔍 Tests | ||
|
||
All tests are [mocked](https://developer.hashicorp.com/terraform/language/tests/mocking) allowing us to test the module without creating infrastructure or requiring credentials. The trade-offs are acceptable in favor of speed and simplicity. In a Terraform test, a mocked provider or resource will generate fake data for all computed attributes that would normally be provided by the underlying provider APIs. | ||
|
||
```none | ||
terraform init | ||
``` | ||
|
||
```none | ||
terraform test | ||
``` | ||
|
||
## 📓 Terraform Documentation | ||
|
||
> A child module automatically inherits default (un-aliased) provider configurations from its parent. The provider versions below are informational only and do **not** need to align with the provider configurations from its parent. | ||
<!-- BEGIN_TF_DOCS --> | ||
### Requirements | ||
|
||
No requirements. | ||
|
||
### Providers | ||
|
||
No providers. | ||
|
||
### Modules | ||
|
||
No modules. | ||
|
||
### Resources | ||
|
||
No resources. | ||
|
||
### Inputs | ||
|
||
No inputs. | ||
|
||
### Outputs | ||
|
||
No outputs. | ||
<!-- END_TF_DOCS --> | ||
|
||
## 📓 Terraform Regional Documentation | ||
|
||
- [regional](regional/README.md) | ||
- [regional/manifests](regional/manifests/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# This is currently required so we can initialize Terraform and run tests. | ||
# https://github.com/hashicorp/terraform/issues/35040 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Terraform Documentation | ||
|
||
> A child module automatically inherits default (un-aliased) provider configurations from its parent. The provider versions below are informational only and do **not** need to align with the provider configurations from its parent. | ||
<!-- BEGIN_TF_DOCS --> | ||
## Requirements | ||
|
||
No requirements. | ||
|
||
## Providers | ||
|
||
| Name | Version | | ||
|------|---------| | ||
| <a name="provider_helm"></a> [helm](#provider\_helm) | 2.14.1 | | ||
| <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) | 2.31.0 | | ||
|
||
## Modules | ||
|
||
No modules. | ||
|
||
## Resources | ||
|
||
| Name | Type | | ||
|------|------| | ||
| [helm_release.cert_manager](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource | | ||
| [kubernetes_namespace_v1.cert_manager](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace_v1) | resource | | ||
|
||
## Inputs | ||
|
||
| Name | Description | Type | Default | Required | | ||
|------|-------------|------|---------|:--------:| | ||
| <a name="input_artifact_registry"></a> [artifact\_registry](#input\_artifact\_registry) | The registry to pull the images from | `string` | `"us-docker.pkg.dev/plt-lz-services-tf79-prod/plt-docker-virtual"` | no | | ||
| <a name="input_cert_manager_version"></a> [cert\_manager\_version](#input\_cert\_manager\_version) | The version to install, this is used for the chart as well as the image tag | `string` | `"1.15.3"` | no | | ||
| <a name="input_chart_repository"></a> [chart\_repository](#input\_chart\_repository) | The repository to pull the cert-manager Helm chart from | `string` | `"https://charts.jetstack.io"` | no | | ||
| <a name="input_cluster_prefix"></a> [cluster\_prefix](#input\_cluster\_prefix) | Prefix for your cluster name | `string` | n/a | yes | | ||
| <a name="input_environment"></a> [environment](#input\_environment) | The environment must be one of `sandbox`, `non-production`, `production` | `string` | `"sandbox"` | no | | ||
| <a name="input_gateway_dns"></a> [gateway\_dns](#input\_gateway\_dns) | Map of attributes for the Istio gateway domain names, it is also used to create the managed certificate resource | <pre>map(object({<br/> managed_zone = string<br/> project = string<br/> }))</pre> | `{}` | no | | ||
| <a name="input_labels"></a> [labels](#input\_labels) | A map of key/value pairs to assign to the resources being created | `map(string)` | `{}` | no | | ||
| <a name="input_node_location"></a> [node\_location](#input\_node\_location) | The zone in which the cluster's nodes should be located. If not specified, the cluster's nodes are located across zones in the region | `string` | `null` | no | | ||
| <a name="input_project"></a> [project](#input\_project) | The ID of the project in which the resource belongs | `string` | n/a | yes | | ||
| <a name="input_region"></a> [region](#input\_region) | The region in which the resource belongs | `string` | n/a | yes | | ||
|
||
## Outputs | ||
|
||
No outputs. | ||
<!-- END_TF_DOCS --> |
Oops, something went wrong.