Chainguard Container for crossplane-function-environment-configs

Crossplane function that manages environment-specific configurations for resources in compositions

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/crossplane-function-environment-configs:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

The crossplane-function-environment-configs image is based on the Crossplane function-environment-configs project. This Chainguard Image provides a secure, minimal runtime environment with the following differences from upstream images:

• Built on Wolfi rather than a traditional Linux distribution, resulting in a smaller attack surface
• Runs as a non-root user (uid 65532) by default for enhanced security
• Contains minimal dependencies with few-to-zero CVEs
• Includes both the function binary and compatibility layer for seamless integration

Getting Started

The crossplane-function-environment-configs image is designed to work with Crossplane compositions for managing environment-specific configurations. The image contains a Crossplane function that can be used to inject environment-specific settings into your resources.

Basic Usage

You can run the function directly to verify it's working:

docker run --rm cgr.dev/ORGANIZATION/crossplane-function-environment-configs:latest --help

Using with Crossplane

Create a function definition for use in your Crossplane cluster:

cat > crossplane-function-environment-configs.yaml <<EOF
apiVersion: pkg.crossplane.io/v1beta1
kind: Function
metadata:
  name: crossplane-function-environment-configs
spec:
  package: cgr.dev/ORGANIZATION/crossplane-function-environment-configs:latest
EOF

Apply the function to your cluster:

kubectl apply -f crossplane-function-environment-configs.yaml

Integration in Compositions

Use the function in your Crossplane compositions to inject environment-specific configurations:

cat > composition-example.yaml <<EOF
apiVersion: apiextensions.crossplane.io/v1
kind: Composition
metadata:
  name: example-with-env-configs
spec:
  compositeTypeRef:
    apiVersion: example.com/v1alpha1
    kind: XExample
  functions:
  - name: environment-configs
    type: function
    source: Function
    ref:
      name: crossplane-function-environment-configs
    input:
      apiVersion: environmentconfigs.fn.crossplane.io/v1beta1
      kind: Input
      spec:
        environmentConfigs:
        - ref:
            name: dev-config
          policy:
            merge: merge
        - ref:
            name: common-config
          policy:
            merge: replace
EOF

Development with the -dev Variant

For debugging and development, use the -dev variant which includes additional tools:

docker run -it cgr.dev/ORGANIZATION/crossplane-function-environment-configs:latest-dev sh

Configuration

The function accepts configuration through its input specification. Key configuration options include:

Environment Config References

Specify which environment configs to apply:

spec:
  environmentConfigs:
  - ref:
      name: my-environment-config
    policy:
      merge: merge  # or "replace"

Merge Policies

• merge: Merge environment config with existing values
• replace: Replace existing values with environment config

Troubleshooting

Crossplane Version Compatibility

If you encounter errors like "incompatible Crossplane version: package is not compatible with Crossplane version (): Invalid Semantic Version", this typically occurs when:

1. Using latest tags: Crossplane requires semantic versioning for compatibility checks. Ensure your Crossplane deployment uses specific version tags (e.g., 2.0.2) instead of latest.

2. Version detection issues: If the error persists with proper version tags, you can bypass version constraints by adding ignoreCrossplaneConstraints: true to your Function specification:

apiVersion: pkg.crossplane.io/v1beta1
kind: Function
metadata:
  name: crossplane-function-environment-configs
spec:
  package: cgr.dev/ORGANIZATION/crossplane-function-environment-configs:latest
  ignoreCrossplaneConstraints: true  # Add this line

Documentation and Resources

• Crossplane Function Environment Configs Documentation
• Crossplane Functions Overview

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.