Skip to content

Latest commit

 

History

History
157 lines (114 loc) · 5.91 KB

README.md

File metadata and controls

157 lines (114 loc) · 5.91 KB
Raw

function-cidr

A Crossplane Composition Function for calculating Classless Inter-Domain Routing (CIDR) numbers.

A CIDR is an IP address allocation method that is used to improve data routing efficiency on the internet.

Overview

This composition function offers 4 HashiCorp compatible IP Network Functions plus two custom wrappers. Follow the function links for detailed explanations of the function semantics.

To use this function, apply the following functions.yaml to your Crossplane management cluster.

cat <<EOF|kubectl apply -f -
apiVersion: pkg.crossplane.io/v1beta1
kind: Function
metadata:
  name: upbound-function-cidr
spec:
  package: xpkg.upbound.io/upbound/function-cidr:v0.4.0
EOF

Call the function from a Crossplane composition as described below.

Terminology

The cidrfunc IP Network Functions have various input parameters. Below are brief descriptions for context.

  • prefix must be given in CIDR notation, as defined in RFC 4632 section 3.1.
  • hostnum is a whole number that can be represented as a binary integer with no more than the number of digits remaining in the address after the given prefix.
  • newbits is the number of additional bits with which to extend the prefix. For example, if given a prefix ending in /16 and a newbits value of 4, the resulting subnet address will have length /20.
  • netnum is a whole number that can be represented as a binary integer with no more than newbits binary digits, which will be used to populate the additional bits added to the prefix.

Usage

Specify the cidrfunc calculation type in the composition function input.

Valid values are as follows:

- cidrhost
- cidrnetmask
- cidrsubnet
- cidrsubnets
- cidrsubnetloop
- multiprefixloop

Specify a custom outputField in the function input parameters when the output should appear at a different path than the respective status.atFunction.cidr sub field default path.

All cidrfunc IP Network Functions require a CIDR prefix as input.

Provide the prefix directly in the function input or specify a prefixField in the XR where the function shall pick up the prefix value.

Function input field names ending in Field indicate that the function shall read the field path value from the specified field path in the XR.

You can also provide desired.composite.resource. and desired.resources. in the prefixField value to reference the resource attribute from where to read the prefix value. See apis/composition-pipeline.yaml. In addition, referencing the pipeline context is supported. You can use gjson for selecting context values. See apis/composition-pipeline-context.yaml.

cidrhost

The cidrhost cidrfunc requires a hostnum or hostnumField as function input. hostnum is an integer.

cidrnetmask

The cidrnetmask cidrfunc does not require additional parameters beyond the prefix. The prefix can be read from an XR field when the prefixField path is specified in the function input instead of a prefix value.

cidrsubnet

The cidrhost cidrsubnet requires a netnum or netnumfield, and a newbits or newbitsfield as function input.

netNum is an integer. newBits is one integer in an array of integers.

cidrsubnets

The cidrhost cidrsubnets requires a newBits or newBitsField as function input.

newBits is an array of integers.

cidrsubnetloop

The cidrhost cidrsubnetloop requires the following input fields.

  • newBits (integer array) or newBitsField
  • netNumCount (integer) or netNumCountField
  • netNumItems (string array) or netNumItemsField
  • offset or offsetField

netNumCount and netNumItems are mutually exclusive

The cidrsubnetloop wrapper calculates cidrsubnet CIDRs using the prefix and newBits parameters as input. It performs the calculations in a loop. The netnum is calculated during each iteration from iteration+offset. The iterations are either from 0 to netNumCount -1 or from 0 to number of items in netNumItemsCount or their respective values from their XR field references.

multiprefixloop

This is an additional convenience function that takes a list of objects, each describing a cidr prefix to split and returns the result as a map[string][]string key'd on the prefix for that block.

It is most useful for scenarios where your composition requires multiple cidr prefixes, such as splitting VPC additional CIDRs for subnet creation.

The multiprefixloop function requires a list of inputs with each input containing:

  • prefix The CIDR prefix to create subnets for
  • newBits An integer array defining how to split the prefix
  • offset An optional bit size to start the subnet range after

If offset is specified, this is prepended to the newBits field immediately before calculations and then removed after the calculation is completed.

Testing The Function

Clone the repo. Run make debug and in a second terminal run make render or make render-pipeline and examine the output. Corresponding compositions and XR yaml can be found in the examples folder.