35aa6b7559
We are renaming Lumi to Pulumi Fabric. This change simply renames the pulumi/lumi repo to pulumi/pulumi-fabric, without the CLI tools and other changes that will follow soon afterwards.
52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
# Lumi IDL
|
|
|
|
The Lumi IDL compiler (LumIDL) compiles an Go-based IDL into Lumi metadata and packages.
|
|
|
|
## IDL
|
|
|
|
The compiler, `lumidl`, accepts a subset of Go. Please refer to [the IDL design document](/docs/idl.md) for details.
|
|
|
|
## Providers
|
|
|
|
The primary use case for Lumi IDL is to author resource packages and providers. A resource package is a low level
|
|
Lumi package with metadata associated with a set of resource type definitions. Its associated provider is a dynamic
|
|
plugin that implements the behavior associated with those resources, their CRUD functions, and operational semantics.
|
|
|
|
The LumIDL toolset cuts down on boilerplate and makes it easy to author new resource packages and providers.
|
|
|
|
## Building
|
|
|
|
To build the Lumi IDL compiler, run
|
|
|
|
$ go install github.com/pulumi/pulumi-fabric/cmd/lumidl
|
|
|
|
from an enlistment with a proper `GOPATH` set.
|
|
|
|
## Running
|
|
|
|
To generate code, run:
|
|
|
|
$ lumidl pkg-name idl-path [flags]
|
|
|
|
where the `pkg-name` is the name of the target Lumi package, `idl-path` is a path to a directory containing IDL, and
|
|
`flags` are an optional set of flags. All `*.go` files in the target directory are parsed and processed as IDL. To
|
|
recursively fetch sub-packages, pass the `--recursive` (or `-r`) flag.
|
|
|
|
The output includes the following:
|
|
|
|
* A Lumi package in LumiJS, containing resource definitions.
|
|
* An RPC package in Go to aid in the creation of a resource provider, containing:
|
|
- A base resource provider that handles marshaling goo at the edges.
|
|
- A marshalable type for each resource type (used for dynamic plugin serialization).
|
|
|
|
The two flags, `--out-pack` and `--out-rpc` control if and where the output will be generated, respectively. It is
|
|
possible to specify just one or the other, or you can generate both simultaneously.
|
|
|
|
By default, the IDL Go package is inferred from a combination of `idl-path` and `GOPATH`. This is used to generate
|
|
inter- and intra-package references. If you are generating RPC code, that too is inferred, based on `--out-rpc` and
|
|
`GOPATH`. In the event you are running outside of a Go workspace (where `GOPATH` is not set), or need to customize
|
|
these, the packages can be set by hand using the flags `--pkg-base-idl` and `--pkg-base-rpc`, respectively.
|
|
|
|
After generating the code and implementing behavior associated with the resource in the provider, the Lumi package
|
|
may then be distributed to consumers using LumiPy, LumiRu, LumiJS, and other LumiLangs.
|
|
|