diff --git a/docs/_home/index.html b/docs/_home/index.html index 2ec5093..91340f7 100644 --- a/docs/_home/index.html +++ b/docs/_home/index.html @@ -1,2 +1,2 @@ - AsCode - Terraform Alternative Syntax
Logo

Documentation

AsCode allows you to describe your infrastructure using an expressive language in Terraform without writing a single line of HCL.

\ No newline at end of file +

Documentation

AsCode allows you to describe your infrastructure using an expressive language in Terraform without writing a single line of HCL.

\ No newline at end of file diff --git a/docs/example/functions.star/index.html b/docs/example/functions.star/index.html new file mode 100644 index 0000000..2272ebe --- /dev/null +++ b/docs/example/functions.star/index.html @@ -0,0 +1,109 @@ +Using functions - AsCode - Terraform Alternative Syntax
Logo

Examples

Using functions

This example illustrates how with the usage through the usage of functions, +we can simplify and improve the readability of our infrastructure declaration.

Instantiates a new AWS provider, aws will be available in the context of +the functions.

aws = tf.provider("aws", region="us-west-2")
+

Every instance requires an ami data source; this data source contains a +very specif configuration like the ID of the owner or a name pattern. So +we define a dictionary with the different values we want to use.

ami_names_owners = {
+    "ubuntu": ["ubuntu/images/*/ubuntu-xenial-16.04-amd64-server-*", "099720109477"],
+    "ecs": ["*amazon-ecs-optimized", "591542846629"],
+}
+

get_ami returns the ami for the given distro. It searches in the +ResouceCollection of the ami data source, if finds the ami it simply +returns it; if not creates a new one using the data from the ami_names_owners +dictionary.

def get_ami(distro):
+    amis = aws.data.ami.search(distro)
+    if len(amis) != 0:
+        return amis[0]
+
+    data = ami_names_owners[distro]
+
+    ami = aws.data.ami(distro)
+    ami.most_recent = True
+    ami.filter(name="name", values=[data[0]])
+    ami.filter(name="virtualization-type", values=["hvm"])
+    ami.owners = [data[1]]
+
+    return ami
+

new_instance instantiates a new instance for the given name, distro and +type, the type has a default value t2.micro. The distro value is resolved +to an ami resource using the previously defined function get_ami.

def new_instance(name, distro, type="t2.micro"):
+    instance = aws.resource.instance(name)
+    instance.instance_type = type
+    instance.ami = get_ami(distro).id
+

Now using a basic for loop we can instantiate 5 different web servers, +where the even machines are using ubuntu and the odd ones ecs.

for i in range(5):
+    distro = "ubuntu"
+    if i % 2: 
+        distro = "ecs"
+
+    new_instance("web_%d" % i, distro)
+

Output

If we execute this script with the flag --print-hcl the result shuld be +something like this:

provider "aws" {
+  alias   = "id_01E4KEA5ZAA1PYERQ8KM5D04GC"
+  version = "2.13.0"
+  region  = "us-west-2"
+}
+
+data "aws_ami" "ubuntu" {
+  provider    = aws.id_01E4KEA5ZAA1PYERQ8KM5D04GC
+  most_recent = true
+  owners      = ["099720109477"]
+
+  filter {
+    name   = "name"
+    values = ["ubuntu/images/*/ubuntu-xenial-16.04-amd64-server-*"]
+  }
+
+  filter {
+    name   = "virtualization-type"
+    values = ["hvm"]
+  }
+}
+
+data "aws_ami" "ecs" {
+  provider    = aws.id_01E4KEA5ZAA1PYERQ8KM5D04GC
+  most_recent = true
+  owners      = ["591542846629"]
+
+  filter {
+    name   = "name"
+    values = ["*amazon-ecs-optimized"]
+  }
+
+  filter {
+    name   = "virtualization-type"
+    values = ["hvm"]
+  }
+}
+
+resource "aws_instance" "web_0" {
+  provider      = aws.id_01E4KEA5ZAA1PYERQ8KM5D04GC
+  ami           = "${data.aws_ami.ubuntu.id}"
+  instance_type = "t2.micro"
+}
+
+resource "aws_instance" "web_1" {
+  provider      = aws.id_01E4KEA5ZAA1PYERQ8KM5D04GC
+  ami           = "${data.aws_ami.ecs.id}"
+  instance_type = "t2.micro"
+}
+
+resource "aws_instance" "web_2" {
+  provider      = aws.id_01E4KEA5ZAA1PYERQ8KM5D04GC
+  ami           = "${data.aws_ami.ubuntu.id}"
+  instance_type = "t2.micro"
+}
+
+resource "aws_instance" "web_3" {
+  provider      = aws.id_01E4KEA5ZAA1PYERQ8KM5D04GC
+  ami           = "${data.aws_ami.ecs.id}"
+  instance_type = "t2.micro"
+}
+
+resource "aws_instance" "web_4" {
+  provider      = aws.id_01E4KEA5ZAA1PYERQ8KM5D04GC
+  ami           = "${data.aws_ami.ubuntu.id}"
+  instance_type = "t2.micro"
+}
+
\ No newline at end of file diff --git a/docs/example/index.html b/docs/example/index.html new file mode 100644 index 0000000..ea6ed09 --- /dev/null +++ b/docs/example/index.html @@ -0,0 +1,6 @@ +Examples - AsCode - Terraform Alternative Syntax
Logo

Examples

Overview

Examples

Using functions

This example illustrates how with the usage through the usage of functions, +we can simplify and improve the readability of our infrastructure declaration.

Runtime Modules

AsCode comes with a variety of modules available like http, math, +encoding/json, etc. All this modules are available +runtime through the load +statement. This example shows the usage of this modules and some others.

\ No newline at end of file diff --git a/docs/example/index.xml b/docs/example/index.xml new file mode 100644 index 0000000..7943e14 --- /dev/null +++ b/docs/example/index.xml @@ -0,0 +1,5 @@ +Examples on AsCode - Terraform Alternative Syntaxhttps://ascode.run/docs/example/Recent content in Examples on AsCode - Terraform Alternative SyntaxHugo -- gohugo.ioen-usUsing functionshttps://ascode.run/docs/example/functions.star/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/example/functions.star/<p>This example illustrates how with the usage through the usage of functions, +we can simplify and improve the readability of our infrastructure declaration.</p>Runtime Moduleshttps://ascode.run/docs/example/runtime.star/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/example/runtime.star/<p>AsCode comes with a variety of modules available like <code>http</code>, <code>math</code>, +<code>encoding/json</code>, etc. All this <a href="https://ascode.run/docs/reference/">modules</a> are available +runtime through the <a href="https://ascode.run/docs/starlark/statements/#load-statements"><code>load</code></a> +statement. This example shows the usage of this modules and some others.</p> \ No newline at end of file diff --git a/docs/example/runtime.star/index.html b/docs/example/runtime.star/index.html new file mode 100644 index 0000000..6b18e81 --- /dev/null +++ b/docs/example/runtime.star/index.html @@ -0,0 +1,28 @@ +Runtime Modules - AsCode - Terraform Alternative Syntax
Logo

Examples

Runtime Modules

AsCode comes with a variety of modules available like http, math, +encoding/json, etc. All this modules are available +runtime through the load +statement. This example shows the usage of this modules and some others.

Basic Module

The load statement expects at least two arguments; the first is the name of +the module, and the same the symbol to extract to it. The runtime modules +always define a symbol called equals to the last part of the module name.

load("encoding/base64", "base64")
+load("http", "http")
+

This modules are very usuful to do basic operations such as encoding of +strings, like in this case to base64 or to make HTTP requests.

dec = base64.encode("ascode is amazing")
+
+msg = http.get("https://httpbin.org/base64/%s" % dec)
+print(msg.body())
+

Output

ascode is amazing
+

Advanced Modules

Also, AsCode has some more specif modules, like the docker module. The +docker modules allow you to manipulate docker image names.

load("experimental/docker", "docker")
+

A docker image tag can be defined using semver, instead of using the infamous +‘latest’ tag, or fixing a particular version. This allows us to be up-to-date +without breaking our deployment.

golang = docker.image("golang", "1.13.x")
+

We can use this in the definition of resources, allowing use to upgrade +the version of our containers in every terraform apply

p = tf.provider("docker", "2.7.0")
+container = p.resource.container("golang", image=golang.version(full=True))
+

version queries the docker repository and returns the correct tag.

print(hcl(container))
+

Output

resource "docker_container" "foo" {
+  provider = docker.id_01E4KHW2RSW0FQM93KN5W70Y42
+  image    = "docker.io/library/golang:1.13.9"
+}
+
\ No newline at end of file diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index 49338e9..06147d9 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -1,5 +1,5 @@ Getting Started - AsCode - Terraform Alternative Syntax
Logo

Documentation

Getting Started

This page explains the basics of using AsCode to define your infrastructure in Terraform. It assumes that you have already installed Ascode.

> ascode --help
+

Documentation

Getting Started

This page explains the basics of using AsCode to define your infrastructure in Terraform. It assumes that you have already installed Ascode.

> ascode --help
 Usage:
   ascode [OPTIONS] <repl | run | version>
 
diff --git a/docs/github-action/index.html b/docs/github-action/index.html
index 0386e5d..2599762 100644
--- a/docs/github-action/index.html
+++ b/docs/github-action/index.html
@@ -1,2 +1,2 @@
 GitHub Action - AsCode - Terraform Alternative Syntax
Logo
Documentation
GitHub Action
TODO
\ No newline at end of file +

Documentation

GitHub Action

TODO

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 743cb9d..6dd86db 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,2 +1,2 @@ Documentation - AsCode - Terraform Alternative Syntax
Logo

Documentation

Overview

Documentation

AsCode - Terraform Alternative Syntax

AsCode is a tool to define infrastructure as code using the Starlark language on top of TerTerraformraform. It allows to describe your infrastructure using an expressive language in Terraform without writing a single line of HCL, meanwhile, you have the complete ecosystem of providers

Why?

Terraform is a great tool, with support for almost everything you can imagine, making it the industry leader. Terraform is based on HCL, a JSON-alike declarative language, with minimal control flow functionality. IMHO, to unleash the power of the IaC, a powerful, expressive language should be used, where basic elements like loops or functions are first-class citizens.

What is Starlark?

Starlark is a dialect of Python intended for use as a configuration language. A Starlark interpreter is typically embedded within a larger application, and this application may define additional domain-specific functions and data types beyond those provided by the core language. For example, Starlark is embedded within (and was originally developed for) the Bazel build tool, and Bazel’s build language is based on Starlark.

\ No newline at end of file +

Documentation

Overview

Documentation

AsCode - Terraform Alternative Syntax

AsCode is a tool to define infrastructure as code using the Starlark language on top of TerTerraformraform. It allows to describe your infrastructure using an expressive language in Terraform without writing a single line of HCL, meanwhile, you have the complete ecosystem of providers

Why?

Terraform is a great tool, with support for almost everything you can imagine, making it the industry leader. Terraform is based on HCL, a JSON-alike declarative language, with minimal control flow functionality. IMHO, to unleash the power of the IaC, a powerful, expressive language should be used, where basic elements like loops or functions are first-class citizens.

What is Starlark?

Starlark is a dialect of Python intended for use as a configuration language. A Starlark interpreter is typically embedded within a larger application, and this application may define additional domain-specific functions and data types beyond those provided by the core language. For example, Starlark is embedded within (and was originally developed for) the Bazel build tool, and Bazel’s build language is based on Starlark.

\ No newline at end of file diff --git a/docs/install/index.html b/docs/install/index.html index 23040d9..3f6fa8b 100644 --- a/docs/install/index.html +++ b/docs/install/index.html @@ -1,5 +1,5 @@ Quick Install - AsCode - Terraform Alternative Syntax
Logo

Documentation

Quick Install

AsCode is written in Go with support for multiple platforms.

The latest release can be found at GitHub Releases., currently provides pre-built binaries for the following:

  • Linux
  • macOS (Darwin)
  • Windows

Binary (Cross-platform)

Download the appropriate version for your platform from GitHub Releases.. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location.

Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Linux

wget https://github.com/mcuadros/ascode/releases/download/dev/ascode-dev-linux-amd64.tar.gz
+

Documentation

Quick Install

AsCode is written in Go with support for multiple platforms.

The latest release can be found at GitHub Releases., currently provides pre-built binaries for the following:

  • Linux
  • macOS (Darwin)
  • Windows

Binary (Cross-platform)

Download the appropriate version for your platform from GitHub Releases.. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location.

Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Linux

wget https://github.com/mcuadros/ascode/releases/download/dev/ascode-dev-linux-amd64.tar.gz
 tar -xvzf ascode-dev-linux-amd64.tar.gz
 mv ascode /usr/local/bin/

macOS (Darwin)

wget https://github.com/mcuadros/ascode/releases/download/dev/ascode-dev-darwin-amd64.tar.gz
diff --git a/index.xml b/index.xml
index cfb952d..953dfb2 100644
--- a/index.xml
+++ b/index.xml
@@ -1,10 +1,14 @@
 AsCode - Terraform Alternative Syntaxhttps://ascode.run/Recent content on AsCode - Terraform Alternative SyntaxHugo -- gohugo.ioen-usQuick Installhttps://ascode.run/docs/install/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/install/AsCode is written in Go with support for multiple platforms.
 The latest release can be found at GitHub Releases., currently provides pre-built binaries for the following:
 Linux macOS (Darwin) Windows Binary (Cross-platform) Download the appropriate version for your platform from GitHub Releases.. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location.
-Ideally, you should install it somewhere in your PATH for easy use.Getting Startedhttps://ascode.run/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/getting-started/This page explains the basics of using AsCode to define your infrastructure in Terraform. It assumes that you have already installed Ascode.
+Ideally, you should install it somewhere in your PATH for easy use.Using functionshttps://ascode.run/docs/example/functions.star/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/example/functions.star/<p>This example illustrates how with the usage through the usage of functions,
+we can simplify and improve the readability of our infrastructure declaration.</p>Getting Startedhttps://ascode.run/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/getting-started/This page explains the basics of using AsCode to define your infrastructure in Terraform. It assumes that you have already installed Ascode.
 &gt; ascode --help Usage: ascode [OPTIONS] &lt;repl | run | version&gt; AsCode - Terraform Alternative Syntax. Help Options: -h, --help Show this help message Available commands: repl Run as interactive shell. run Run parses, resolves, and executes a Starlark file. version Version prints information about this binary. The repl command The repl command provides a handy REPL interface for debugging and tinkering with AsCode.Lexical elementshttps://ascode.run/docs/starlark/lexical-elements/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/starlark/lexical-elements/A Starlark program consists of one or more modules. Each module is defined by a single UTF-8-encoded text file.
 A complete grammar of Starlark can be found in grammar.txt. That grammar is presented piecemeal throughout this document in boxes such as this one, which explains the notation:
-Grammar notation - lowercase and &#39;quoted&#39; items are lexical tokens. - Capitalized names denote grammar productions. - (...) implies grouping. - x | y means either x or y.Data typeshttps://ascode.run/docs/starlark/data-types/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/starlark/data-types/Overview These are the main data types built in to the interpreter:
+Grammar notation - lowercase and &#39;quoted&#39; items are lexical tokens. - Capitalized names denote grammar productions. - (...) implies grouping. - x | y means either x or y.Runtime Moduleshttps://ascode.run/docs/example/runtime.star/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/example/runtime.star/<p>AsCode comes with a variety of modules available like <code>http</code>, <code>math</code>,
+<code>encoding/json</code>, etc. All this <a href="https://ascode.run/docs/reference/">modules</a> are available
+runtime through the <a href="https://ascode.run/docs/starlark/statements/#load-statements"><code>load</code></a>
+statement. This example shows the usage of this modules and some others.</p>Data typeshttps://ascode.run/docs/starlark/data-types/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/starlark/data-types/Overview These are the main data types built in to the interpreter:
 NoneType # the type of None bool # True or False int # a signed integer of arbitrary magnitude float # an IEEE 754 double-precision floating point number string # a byte string list # a modifiable sequence of values tuple # an unmodifiable sequence of values dict # a mapping from values to values set # a set of values function # a function implemented in Starlark builtin_function_or_method # a function or method implemented by the interpreter or host application Some functions, such as the iteration methods of string, or the range function, return instances of special-purpose types that don&rsquo;t appear in this list.Name binding and variableshttps://ascode.run/docs/starlark/name-binding-and-variables/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/starlark/name-binding-and-variables/After a Starlark file is parsed, but before its execution begins, the Starlark interpreter checks statically that the program is well formed. For example, break and continue statements may appear only within a loop; a return statement may appear only within a function; and load statements may appear only outside any function.
 Name resolution is the static checking process that resolves names to variable bindings. During execution, names refer to variables.Value conceptshttps://ascode.run/docs/starlark/value-concepts/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/starlark/value-concepts/Overview Starlark has eleven core data types. An application that embeds the Starlark intepreter may define additional types that behave like Starlark values. All values, whether core or application-defined, implement a few basic behaviors:
 str(x) -- return a string representation of x type(x) -- return a string describing the type of x bool(x) -- convert x to a Boolean truth value Identity and mutation Starlark is an imperative language: programs consist of sequences of statements executed for their side effects.Expressionshttps://ascode.run/docs/starlark/expressions/Mon, 01 Jan 0001 00:00:00 +0000https://ascode.run/docs/starlark/expressions/Overview An expression specifies the computation of a value.
diff --git a/sitemap.xml b/sitemap.xml
index 163c0a0..a0d3abb 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-https://ascode.run/docs/https://ascode.run/docs/install/https://ascode.run/docs/getting-started/https://ascode.run/docs/starlark/lexical-elements/https://ascode.run/docs/starlark/data-types/https://ascode.run/docs/starlark/name-binding-and-variables/https://ascode.run/docs/starlark/value-concepts/https://ascode.run/docs/starlark/expressions/https://ascode.run/docs/starlark/statements/https://ascode.run/docs/starlark/module-execution/https://ascode.run/docs/starlark/built-in-constants-and-functions/https://ascode.run/docs/starlark/built-in-methods/https://ascode.run/docs/starlark/https://ascode.run/docs/starlark/dialect-differences/https://ascode.run/docs/reference/https://ascode.run/docs/github-action/https://ascode.run/https://ascode.run/docs/_home/https://ascode.run/docs/reference/types/https://ascode.run/categories/https://ascode.run/docs/reference/base64/https://ascode.run/docs/reference/csv/https://ascode.run/docs/reference/json/https://ascode.run/docs/reference/yaml/https://ascode.run/docs/reference/http/https://ascode.run/docs/reference/math/https://ascode.run/docs/reference/os/https://ascode.run/docs/reference/filepath/https://ascode.run/docs/reference/re/https://ascode.run/tags/https://ascode.run/docs/reference/time/
\ No newline at end of file
+https://ascode.run/docs/https://ascode.run/docs/install/https://ascode.run/docs/example/functions.star/https://ascode.run/docs/getting-started/https://ascode.run/docs/starlark/lexical-elements/https://ascode.run/docs/example/runtime.star/https://ascode.run/docs/starlark/data-types/https://ascode.run/docs/starlark/name-binding-and-variables/https://ascode.run/docs/starlark/value-concepts/https://ascode.run/docs/starlark/expressions/https://ascode.run/docs/starlark/statements/https://ascode.run/docs/starlark/module-execution/https://ascode.run/docs/starlark/built-in-constants-and-functions/https://ascode.run/docs/starlark/built-in-methods/https://ascode.run/docs/starlark/https://ascode.run/docs/starlark/dialect-differences/https://ascode.run/docs/reference/https://ascode.run/docs/example/https://ascode.run/docs/github-action/https://ascode.run/https://ascode.run/docs/_home/https://ascode.run/docs/reference/types/https://ascode.run/categories/https://ascode.run/docs/reference/base64/https://ascode.run/docs/reference/csv/https://ascode.run/docs/reference/json/https://ascode.run/docs/reference/yaml/https://ascode.run/docs/reference/http/https://ascode.run/docs/reference/math/https://ascode.run/docs/reference/os/https://ascode.run/docs/reference/filepath/https://ascode.run/docs/reference/re/https://ascode.run/tags/https://ascode.run/docs/reference/time/
\ No newline at end of file