| commit | ec427f9822aa1b85cc1424a243c4de396e8c9fb6 | [log] [tgz] |
|---|---|---|
| author | Paul Jolly <paul@myitcv.org.uk> | Mon May 24 17:18:22 2021 +0100 |
| committer | Paul Jolly <paul@myitcv.org.uk> | Tue May 25 14:52:27 2021 +0000 |
| tree | 5feab0dad0b69f93e41c2adaf8f985d669a309bf | |
| parent | 8e053d40424b7ce5be8f42fbbdf489904eb893f3 [diff] |
cmd/cue: fix up get go docs around "enum" types A legacy of pre-# definitions. Change-Id: Ie341b5884672562bd525b64081faa40c5c379945 Reviewed-on: https://cue-review.googlesource.com/c/cue/+/9901 Reviewed-by: CUE cueckoo <cueckoo@gmail.com> Reviewed-by: Marcel van Lohuizen <mpvl@golang.org>
Configure, Unify, Execute
CUE is an open source data constraint language which aims to simplify tasks involving defining and using data.
It is a superset of JSON, allowing users familiar with JSON to get started quickly.
You can use CUE to
CUE merges the notion of schema and data. The same CUE definition can simultaneously be used for validating data and act as a template to reduce boilerplate. Schema definition is enriched with fine-grained value definitions and default values. At the same time, data can be simplified by removing values implied by such detailed definitions. The merging of these two concepts enables many tasks to be handled in a principled way.
Constraints provide a simple and well-defined, yet powerful, alternative to inheritance, a common source of complexity with configuration languages.
The CUE scripting layer defines declarative scripting, expressed in CUE, on top of data. This solves three problems: working around the closedness of CUE definitions (we say CUE is hermetic), providing an easy way to share common scripts and workflows for using data, and giving CUE the knowledge of how data is used to optimize validation.
There are many tools that interpret data or use a specialized language for a specific domain (Kustomize, Ksonnet). This solves dealing with data on one level, but the problem it solves may repeat itself at a higher level when integrating other systems in a workflow. CUE scripting is generic and allows users to define any workflow.
CUE is designed for automation. Some aspects of this are:
Download the latest release from GitHub.
Using Homebrew, you can install using the CUE Homebrew tap:
brew install cuelang/tap/cue
If you already have Go installed, the short version is:
GO111MODULE=on go get cuelang.org/go/cmd/cue
Or, if you are using Go 1.16:
go install cuelang.org/go/cmd/cue@latest
This will install the cue command line tool.
For more details see Installing CUE.
The fastest way to learn the basics is to follow the tutorial on basic language constructs.
A more elaborate tutorial demonstrating of how to convert and restructure an existing set of Kubernetes configurations is available in written form.
Language Specification: official CUE Language specification.
API: the API on pkg.go.dev
Builtin packages: builtins available from CUE programs
cue Command line reference: the cue command
Our canonical Git repository is located at https://cue.googlesource.com.
To contribute, please read the Contribution Guide.
To report issues or make a feature request, use the issue tracker.
Changes can be contributed using Gerrit or Github pull requests.
You can get in touch with the cuelang community in the following ways:
Unless otherwise noted, the CUE source files are distributed under the Apache 2.0 license found in the LICENSE file.
This is not an officially supported Google product.