An open API service indexing awesome lists of open source software.

https://github.com/johanste/hippo-module


https://github.com/johanste/hippo-module

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# hippo-module
Prototype for representing ARM modules using [jsonnet](https://jsonnet.org).

## Getting started

### Running examples

1) Clone the repository
2) Make sure that you have jsonnet installed and on your path
3) Run `jsonnet -J `

## How to contribute

### Structure of the repository

```

+-- core
+-- module.libsonnet # Main module file exposing module
+-- moduledef.libsonnet # Structure of a module
+-- resource.libsonnet # Structure for an individual resource
+-- example_consumers
+-- vmss_cli.jsonnet # Intended to be a module used by the azure cli vmss create command
+--
+-- module.libsonnet
```

### Module
A module is a folder that contains the following files:

```
modulename
+-- module.libsonnet
+-- parameters.schema.json
+--
```
where modulename is the name of the module.

### module.json
The structure of a module is a json object with two required properties; resources and outputs.

```
local core = import 'core/module.libsonnet';

{
resources: {
resource1: core.Module {
},
resource2: core.Module {
}
},
outputs: {
}
}
```