Skip to content

Latest commit

 

History

History
178 lines (115 loc) · 4.8 KB

README.md

File metadata and controls

178 lines (115 loc) · 4.8 KB
Raw

policy

policy - the CLI for managing authorization policies

The policy CLI is a tool for building, versioning and publishing your authorization policies. It uses OCI standards to manage artifacts, and the Open Policy Agent (OPA) to compile and run.

Go Report Card ci codebeat badge GitHub all releases Apache 2.0 GitHub release (latest SemVer) CodeQL

Documentation

Please refer to our documentation site for installation, usage, customization and tips.

Slack Channel

Wanna discuss features or show your support for this tool?

Installation

policy is available on Linux, macOS and Windows platforms.

  • Binaries for Linux, Windows and Mac are available as tarballs in the release page.

  • Via Homebrew for macOS or LinuxBrew for Linux

    brew tap opcr-io/tap && brew install opcr-io/tap/policy

  • Via a GO install

    go install github.com/opcr-io/policy/cmd/policy@latest

Building From Source

policy is currently using go v1.16 or above. In order to build policy from source you must:

  1. Install mage

  2. Clone the repo

  3. Build and run the executable

    mage build && ./dist/build_linux_amd64/policy

Running with Docker

Running the official Docker image

You can run as a Docker container:

docker run -it --rm ghcr.io/opcr-io/policy:latest --help

The Command Line

$ policy --help
Usage: policy <command>

Flags:
  -h, --help             Show context-sensitive help.
  -c, --config="/Users/ogazitt/.config/policy/config.yaml"
                         Path to the policy CLI config file.
      --debug            Enable debug mode.
  -v, --verbosity=INT    Use to increase output verbosity.
  -k, --insecure         Do not verify TLS connections.

Commands:
  build <path> ...
    Build policies.

  images
    List policy images.

  push <policy> ...
    Push policies to a registry.

  pull <policy> ...
    Pull policies from a registry.

  login --username=STRING
    Login to a registry.

  logout
    Logout from a registry.

  save <policy>
    Save a policy to a local bundle tarball.

  tag <policy> <tag>
    Create a new tag for an existing policy.

  rm <policy> ...
    Removes a policy from the local registry.

  inspect <policy>
    Displays information about a policy.

  repl <policy>
    Sets you up with a shell for running queries using an OPA instance with a policy loaded.

  remote set-public <policy> [<public>]
    Make a policy public or private.

  remote images
    Synonym for 'policy images --remote'.

  init [<path>]
    (Deprecated) Initialize policy repo

  templates apply <template>
    Create or update a policy or related artifacts from a template.

  templates list
    List all available templates.

  version
    Prints version information.

Run "policy <command> --help" for more information on a command.

Logs

Logs are printed to stderr. You can increase detail using the verbosity flag (e.g. -vvv).

Demo Videos/Recordings

demo

Known Issues

This is still work in progress! If something is broken or there's a feature that you want, please file an issue and if so inclined submit a PR!

Credits

The policy CLI uses a lot of great and amazing open source projects and libraries. A big thank you to all of them!

Contributions Guideline

  • File an issue first prior to submitting a PR!
  • Ensure all exported items are properly commented
  • If applicable, submit a test suite against your PR