kubectl-plugin-arcane

README

kubectl-plugin-arcane

A kubectl plugin for managing Arcane streams.

Features

• Start, stop, and backfill streams
• Declare and stop downtime for streams
• Integrates with Kubernetes via kubectl

Installation

Manual

1. Download the latest release binary:

   Go to the releases page and download the binary for your operating system and architecture.

2. Move the binary to ~/.local/bin:

   mkdir -p ~/.local/bin
   mv path/to/downloaded/kubectl-arcane ~/.local/bin/
   chmod +x ~/.local/bin/kubectl-arcane
   

3. Add ~/.local/bin to your PATH (if not already):

   Add the following line to your ~/.zshrc or ~/.bashrc:

   export PATH="$HOME/.local/bin:$PATH"
   

   Then reload your shell:

   source ~/.zshrc  # or source ~/.bashrc
   

4. Verify installation:

   kubectl arcane --help
   

5. Unset Quarantine attribute on MacOS if you encounter permission issues:

   xattr -d com.apple.quarantine ~/.local/bin/kubectl-arcane
   

Usage

This plugin adds the arcane command to kubectl with the following subcommands:

Stream Commands

• kubectl arcane stream start <stream-class> <stream-id>
  • Start a stream
• kubectl arcane stream stop <stream-class> <stream-id>
  • Stop a stream
• kubectl arcane stream backfill <stream-class> <stream-id> [--wait]
  • Run a stream in backfill mode
  • --wait: Wait for backfill command to complete

Downtime Commands

• kubectl arcane downtime declare <stream-class> <mask> <key>
  • Begin downtime for a stream or a list of streams, use the <key> parameter to resume the stream(s) later
• kubectl arcane downtime stop <stream-class> <key>
  • Stop downtime for a stream or a list of streams, use the <key> parameter to identify the stream(s) to resume

Help

For more information on a command, use:

kubectl arcane <command> --help

License

See LICENSE.