overlock

README

Overlock

Overlock is a lightweight CLI tool designed to simplify the management of Crossplane resources and environments. It supports KinD, K3s, and K3d clusters, making it ideal for local development and testing of Crossplane configurations and providers.

Features

• Easily manage Crossplane environments: Create and manage Crossplane environments for local development or testing purposes.
• Supports multiple cluster types: Works with KinD, K3s, and K3d, allowing you to choose the cluster type best suited for your development and testing needs.
• Local and remote package registries: Manage both local and remote Crossplane registries to handle configurations and providers.
• Load and apply Crossplane configurations: Seamlessly load Crossplane configuration packages from local .xpkg files or apply them directly from remote URLs.
• Provider management: Easily load and apply Crossplane providers from .xpkg files, supporting rapid local development.
• Simplified interface: Overlock automates Crossplane installation, ensuring the setup process is hassle-free and quick.

Installation

To install Overlock, follow these steps:

Prerequisites

• Linux-based operating system
• Docker installed and running

Install via pre-compiled binary

1. Visit the GitHub Releases page and download the appropriate .tar.gz archive for your system (e.g., overlock-0.1.0-linux-amd64.tar.gz).

2. Extract the downloaded archive:

   tar -xvzf overlock-0.1.0-linux-amd64.tar.gz
   

3. Move the extracted binary to a directory in your PATH (e.g., /usr/local/bin):

   sudo mv overlock /usr/local/bin/
   

4. Verify the installation:

   overlock --version
   

Usage

Overlock simplifies Crossplane setup and management across different cluster types. Use the following commands to work with your environment:

• Create or delete a Crossplane environment:

  overlock environment create|delete <environment-name>
  

• Create or delete a local Crossplane package registry:

  overlock registry create|delete [--local] [--default]
  

• Create or delete a remote private Crossplane registry:

  overlock registry create|delete [--default] --registry-server=<httpsurl> --username=<string> --password=<string> --email=<string>
  

• Load a Crossplane configuration from a local .xpkg file:

  overlock configuration load <file>
  

• Apply a Crossplane configuration from a remote URL:

  overlock configuration apply <url>
  

• Load and apply a Crossplane provider from an .xpkg file:

  overlock provider load --apply --path=<file.xpkg> provider-name:version
  

Overlock will automatically set up Crossplane on the specified cluster type (KinD, K3s, or K3d) based on your configuration.

Contributing

We welcome contributions! Please see the CONTRIBUTING.md for more details on how to get involved.

License

This project is licensed under the MIT License. See the LICENSE file for details.