{"id":20537615,"url":"https://github.com/johanste/armm-module-demo","last_synced_at":"2026-02-13T14:59:59.059Z","repository":{"id":87610510,"uuid":"127982809","full_name":"johanste/armm-module-demo","owner":"johanste","description":null,"archived":false,"fork":false,"pushed_at":"2018-04-04T17:07:21.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-31T22:27:46.478Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/johanste.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-04T00:03:41.000Z","updated_at":"2018-04-04T01:14:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"fbf006c3-c98a-4828-ab55-9b97ded817a9","html_url":"https://github.com/johanste/armm-module-demo","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/johanste/armm-module-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanste%2Farmm-module-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanste%2Farmm-module-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanste%2Farmm-module-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanste%2Farmm-module-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johanste","download_url":"https://codeload.github.com/johanste/armm-module-demo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johanste%2Farmm-module-demo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29411138,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T00:41:51.377Z","updated_at":"2026-02-13T14:59:59.019Z","avatar_url":"https://github.com/johanste.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Modules\r\n\r\n## Definition\r\nA module is a jsonnet library that, when evaluated, yields an object conforming to the following subset of attributes of an ARM template: \r\n\r\n```\r\n{\r\n    resources: [\r\n        { \u003cresource definition\u003e }\r\n    ],\r\n\r\n    outputs: {\r\n        ...: {\r\n            ...\r\n        }\r\n        ...\r\n    }\r\n}\r\n```\r\n*(In fact, an existing ARM template intended for inline use is a valid Module per this definition)*\r\n\r\nA module can be parameterized. Argument values are passed to the module by injecting a 'parameters' environment variable into the execution environment (equivaluent of passing a `ext-str parameters=...` to the [jsonnet cli](http://jsonnet.org/implementation/commandline.html))\r\n\r\n## Conventions\r\nIn addition to the core definition of a module, there are several conventions that, when followed, provide surrounding tooling with additional information/capabilities.\r\n\r\n### Introspection/module metadata\r\n\r\nA module may declare parameters that it supports by providing a parmameterMetadata attribute. The parameterMetadata attribute includes the name, type and default value for parameters. *TODO: additional functionality can be added to parameterMetadata, including imperative validation, descriptions, enum values etc.)*\r\n\r\nExample: \r\n```\r\n{\r\n    parameterMetadata:: {\r\n        stringValue: {\r\n            type: 'string'\r\n        },\r\n        optionalIntegerValue: {\r\n            type: 'number',\r\n            defaultValue: 7\r\n        }\r\n    }\r\n}\r\n```\r\n\r\nA caller may inspect what arguments a module provides by examining the *parameterMetadata* field of the module. \r\nThe *parameterMetadata* can also be used by the module (or caller) to validate the provided parameters.\r\n\r\n*TODO: if we rename `parameterMetadata` to `parameters`, and make sure we follow the same schema as an ARM template's parameters section, we have an ever stronger correlation between `ARM templates` and `Modules`. This way, we'd also make it a formal part of a module definition rather than a convention*\r\n### Id field\r\n\r\nIn many cases, a module logically defines a root (anchor) resource with a set of dependent resources. A module may chose to expose this id to other modules by providing a top level id attribute. \r\n\r\n## Platform libraries\r\n\r\n### Module base implementation\r\n\r\nA module author may take advantage of a core module definition that provides validation of parameters based on parameterMetadata.\r\n\r\n### Resource base implementation\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohanste%2Farmm-module-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohanste%2Farmm-module-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohanste%2Farmm-module-demo/lists"}