Getting Started on function-hcl

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Before installing function-hcl you need:

A Kubernetes cluster with Crossplane v1.14 or later installed.
kubectl configured to point at your cluster.

Install via Crossplane Package

The recommended way to install function-hcl is as a Crossplane Function package:

apiVersion: pkg.crossplane.io/v1
kind: Function
metadata:
 name: function-hcl
spec:
 package: xpkg.upbound.io/crossplane-contrib/function-hcl:v0.2.0-rc9

Apply it to your cluster:

kubectl apply -f function.yaml

Verify the function is healthy:

kubectl get function function-hcl

You should see HEALTHY: True and INSTALLED: True in the output.

Quickstart

Mon, 01 Jan 0001 00:00:00 +0000

This quickstart creates a simple composition that provisions an S3 bucket using function-hcl.

1. Define a Composite Resource

First, define an XRD and a Claim type for a storage bucket:

apiVersion: apiextensions.crossplane.io/v1
kind: CompositeResourceDefinition
metadata:
 name: xstoragebuckets.example.crossplane.io
spec:
 group: example.crossplane.io
 names:
 kind: XStorageBucket
 plural: xstoragebuckets
 claimNames:
 kind: StorageBucket
 plural: storagebuckets
 versions:
 - name: v1
 served: true
 referenceable: true
 schema:
 openAPIV3Schema:
 type: object
 properties:
 spec:
 type: object
 properties:
 parameters:
 type: object
 required: [region]
 properties:
 region:
 type: string
 description: AWS region for the bucket
 status:
 type: object
 properties:
 bucketArn:
 type: string

Apply it:

IDE Setup

Mon, 01 Jan 0001 00:00:00 +0000

function-hcl has a language server (function-hcl-ls) that provides IDE features for .hcl files used in function-hcl compositions. Extensions are available for VS Code and IntelliJ.

Features

The language server provides:

Code completion
Diagnostics (error reporting)
Hover information
Go to definition
Document symbols
Semantic token highlighting

Installation instructions

Coming soon. Watch this space…