Nadia, OpenTofu, cdk8s

.tofu-version

@@ -0,0 +1 @@
+1.8.2

README.md

@@ -7,9 +7,8 @@ less like the AWS Cloud Development Kit (CDK) and more like Terraform.
 
 ## Background
 Helicopyter uses [CDKTF](https://github.com/hashicorp/terraform-cdk) and is inspired by
-[Configerator](https://research.facebook.com/file/877841159827226/holistic-configuration-management-at-facebook.pdf),
-[Terraformpy](https://github.com/NerdWalletOSS/terraformpy), and
-[Terraform JSON configuration syntax](https://developer.hashicorp.com/terraform/language/syntax/json).
+[Configerator](https://research.facebook.com/file/877841159827226/holistic-configuration-management-at-facebook.pdf) and
+[Terraformpy](https://github.com/NerdWalletOSS/terraformpy).
 
 ## What Helicopyter does (goals)
 - Name in the resource-prefix Terraform style, instead of the hash-suffix CDK style. This makes
@@ -67,7 +66,7 @@ Helicopyter uses [CDKTF](https://github.com/hashicorp/terraform-cdk) and is insp
 -
 -app.synth()
 ```
-- Enable hand-written Hashicorp Configuration Language (HCL) files and auto-generated HCL/JSON to
+- Enable hand-written and auto-generated Hashicorp Configuration Language (HCL) files to
   co-exist, allowing incremental adoption.
 - Separate object instantiation from synthesis, allowing Python script to import the objects/data
   and do completely different things with them.
@@ -76,7 +75,7 @@ Helicopyter uses [CDKTF](https://github.com/hashicorp/terraform-cdk) and is insp
 
 ## What Helicopyter will probably never do (non-goals)
 - Support languages other than Python
-- Make use of the CDKTF's command line interface. Integration with it is untested and not recommended.
+- Make use of CDKTF's command line interface. Integration with it is untested and not recommended.
 
 ## What Helicopyter might do in the future
 - Support multiple backend configurations per codename
@@ -88,4 +87,4 @@ Helicopyter uses [CDKTF](https://github.com/hashicorp/terraform-cdk) and is insp
 - Why do we need a Node.js server? Can we build dataclasses or Pydantic models out of the type annotations already being
   generated?
 - Provide helper classes or functions for useful but annoyingly verbose patterns such as local-exec provisioner command
-- Backend / state file linter: prod must exist, and region/bucket/workspace_key_prefix/key must follow pattern
+- Backend / state file linter, such as prod must exist, and region/bucket/workspace_key_prefix/key must follow pattern

deploys/buddies/terraform/main.py

@@ -10,6 +10,7 @@
     'duncan.tormey': ('DuncanTormey', 'admin'),
     'james.braza': ('jamesbraza', 'admin'),
     'matt.fowler': ('mattefowler', 'admin'),
+    'nadia.wallace': ('16NWallace', 'admin'),
 }
 
 

deploys/buddies/terraform/main.tf

@@ -36,3 +36,8 @@ resource "github_membership" "matt_fowler" {
   role     = "admin"
   username = "mattefowler"
 }
+
+resource "github_membership" "nadia_wallace" {
+  role     = "admin"
+  username = "16NWallace"
+}

deploys/foundation/terraform/main.py

@@ -8,6 +8,7 @@
     'airdjang': ('Airflow + Django', ['airflow', 'django', 'python']),
     'allowedflare': ('Intranet connectivity for Django and more', ['django', 'python']),
     'helicopyter': ('Python-defined infrastructure', ['ansible', 'cdktf', 'python', 'terraform']),
+    'wellplated': ('Python Django models for liquid handling', ['django', 'python']),
 }
 
 

documentation/djangocon-us-2024.md

@@ -0,0 +1,118 @@
+## Why Write Down Infrastructure?
+* Reproducibility
+* Automation
+* Disaster recovery
+
+## Why Use Terraform?
+* Simplicity
+* Wealth of providers
+* Good diffing
+
+## Original CDKTF
+```python
+#!/usr/bin/env python
+
+from constructs import Construct
+from cdktf import App, TerraformStack
+from cdktf_cdktf_provider_docker.image import Image
+from cdktf_cdktf_provider_docker.container import Container
+from cdktf_cdktf_provider_docker.provider import DockerProvider
+
+
+class MyStack(TerraformStack):
+    def __init__(self, scope: Construct, ns: str):
+        super().__init__(scope, ns)
+
+        DockerProvider(self, 'docker')
+
+        docker_image = Image(self, 'nginxImage',
+            name='nginx:latest',
+            keep_locally=False)
+
+        Container(self, 'nginxContainer',
+            name='tutorial',
+            image=docker_image.name,
+            ports=[{
+                'internal': 80,
+                'external': 8000
+            }])
+
+
+app = App()
+MyStack(app, "learn-cdktf-docker")
+
+app.synth()
+```
+
+## Diff from CDKTF to Helicopyter
+```diff
+--- documentation/learn_cdktf_docker.py   2024-08-05 08:47:30
++++ documentation/learn_helicopyter_docker.py     2024-08-05 08:47:25
+@@ -1,28 +1,18 @@
+-from cdktf import App, TerraformStack
+ from cdktf_cdktf_provider_docker.container import Container
+ from cdktf_cdktf_provider_docker.image import Image
+-from cdktf_cdktf_provider_docker.provider import DockerProvider
+-from constructs import Construct
++from helicopyter import HeliStack
+
+-class MyStack(TerraformStack):
+-    def __init__(self, scope: Construct, ns: str):
+-        super().__init__(scope, ns)
++def synth(stack: HeliStack):
+- 
+-        DockerProvider(self, 'docker')
++    stack.provide('docker')
+
+-        docker_image = Image(self, 'nginxImage', name='nginx:latest', keep_locally=False)
++    docker_image = stack.push(Image, 'nginxImage', name='nginx:latest', keep_locally=False)
+
+-        Container(
+-            self,
+-            'nginxContainer',
+-            name='tutorial',
+-            image=docker_image.name,
+-            ports=[{'internal': 80, 'external': 8000}],
+-        )
++    stack.push(
++        Container,
++        'nginxContainer',
++        name='tutorial',
++        image=docker_image.name,
++        ports=[{'internal': 80, 'external': 8000}],
++    )
+-
+-
+-app = App()
+-MyStack(app, 'learn-cdktf-docker')
+-
+-app.synth()
+```
+
+## Helicopyter
+```python
+from cdktf_cdktf_provider_docker.container import Container
+from cdktf_cdktf_provider_docker.image import Image
+from helicopyter import HeliStack
+
+def synth(stack: HeliStack):
+    stack.provide('docker')
+
+    docker_image = stack.push(Image, 'nginxImage', name='nginx:latest', keep_locally=False)
+
+    stack.push(
+        Container,
+        'nginxContainer',
+        name='tutorial',
+        image=docker_image.name,
+        ports=[{'internal': 80, 'external': 8000}],
+    )
+```
+
+## Uses
+* Containers for Gunicorn web servers and Celery workers
+* PostgreSQL database
+* Load balancers
+* Intranetworking (authenticating proxy)
+* Git repository configuration
+* Accounts and access to service providers

helicopyter.py

@@ -7,11 +7,17 @@
 from subprocess import check_output
 from typing import Any, TypeVar
 
+from cdk8s import Chart
 from cdktf import App, TerraformElement, TerraformStack
 from constructs import Construct, Node
 from tap import Tap
 
 
+class HeliChart(Chart):
+    def __init__(self, cona: str) -> None:
+        super().__init__(App(outdir='.'), cona)
+        self.cona = cona
+
 class HeliStack(TerraformStack):
     def __init__(self, cona: str) -> None:
         # Something is automatically creating outdir, which is cdktf.out by default
@@ -77,9 +83,9 @@ def push(
 def multisynth(
     all_or_conas_or_paths: Iterable[str],
     *,
-    change_directory: Path | None = None,
-    hashicorp_configuration_language: bool = True,
-    format_with: str = 'terraform',
+    change_directory: Path | None,
+    hashicorp_configuration_language: bool,
+    format_with: str,
 ) -> None:
     if not all_or_conas_or_paths:
         print('No codenames specified. Doing nothing.')
@@ -146,6 +152,7 @@ def multisynth(
 class Parameters(Tap):
     conas: list[str]  # space-separated COdeNAmes
     directory: Path | None = None
+    format_with: str = 'terraform'
     hashicorp_configuration_language: bool = True
 
     def configure(self) -> None:  # noqa: D102
@@ -158,5 +165,6 @@ def configure(self) -> None:  # noqa: D102
     multisynth(
         args.conas,
         change_directory=args.directory,
+        format_with=args.format_with,
         hashicorp_configuration_language=args.hashicorp_configuration_language,
     )

includes.sh

@@ -322,15 +322,15 @@ hta() {
         return 1
     fi
     shift 2
-    python -m helicopyter "$cona"
-    TF_WORKSPACE="$envi" terraform -chdir="deploys/$cona/terraform" apply "$@"
+    python -m helicopyter --format_with="${INSH_TF:-terraform}" "$cona"
+    TF_WORKSPACE="$envi" ${INSH_TF:-terraform} -chdir="deploys/$cona/terraform" apply "$@"
 }
 
 hti() {
     : 'Helper for Terraform Init'
     local cona="${1?:Please provide a code name as the first argument}"
     shift
-    terraform -chdir="deploys/$cona/terraform" init "$@"
+    ${INSH_TF:-terraform} -chdir="deploys/$cona/terraform" init "$@"
 }
 
 htp() {
@@ -343,8 +343,8 @@ htp() {
         return 1
     fi
     shift 2
-    python -m helicopyter "$cona"
-    TF_WORKSPACE="$envi" terraform -chdir="deploys/$cona/terraform" plan "$@"
+    python -m helicopyter --format_with="${INSH_TF:-terraform}" "$cona"
+    TF_WORKSPACE="$envi" ${INSH_TF:-terraform} -chdir="deploys/$cona/terraform" plan "$@"
 }
 
 pc() {

package.json

@@ -5,5 +5,8 @@
     },
     "scripts": {
         "prettier": "prettier --write"
+    },
+    "dependencies": {
+        "cdk8s-cli": "^2.198.227"
     }
 }