Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 4.7 KB

README.md

File metadata and controls

103 lines (68 loc) · 4.7 KB
Raw

OpenSSF Scorecard

Privateer

Simplifying Validation for Infrastructure Engineers

Privateer has been meticulously crafted with infrastructure engineers in mind. If you're seeking to validate your resources against regulations, taxonomies, or standards, Privateer is your trusted companion. With a user-friendly interface and powerful features, you can now effortlessly navigate the complexities of resource validation.

Using Privateer Raids

There are several key benefits to Privateer Raids:

  • Community-Driven Raids: Our open development model ensures that Raids are crafted and maintained collaboratively by the community, reflecting a wealth of expertise and insights.
  • Comprehensive Resource Validation: Privateer empowers you to validate a diverse array of resources in a single execution. No more piecemeal validation processes; instead, experience efficiency and thoroughness in one go.
  • Consistent Machine-Readable Output: Regardless of the specific Raid, you're guaranteed a standardized, machine-readable test output. This consistency simplifies the automation and integration of test results, enabling seamless decision-making.
  • Empowering Service Providers: Privateer finds its calling in projects like Compliant Financial Infrastructure and Common Cloud Controls within FINOS. Service providers can leverage Privateer Raids developed by FINOS to certify resources for use in regulated industries, such as insurance and banking.

Install the Privateer CLI

Option 1: Install via Script

Run the following command to install Privateer using the provided install.sh script:

/bin/bash -c "$(curl -sSL https://raw.githubusercontent.com/privateerproj/privateer/03ced90caae9f3c9203eb7f82f2c46ccf2ff15fc/install.sh)"

Option 2: Download from Releases

Download the latest release from GitHub Releases.

Build Privateer from Source

To build privateer from source, follow these steps below:

  1. Clone the Repository

    git clone https://github.com/privateerproj/privateer.git
cd privateer

  2. Installting Dependencies

    go mod tidy

  3. Building Privateer

    make release

Install Privateer Raids

Raids are built and maintained by the community. Choose the raid(s) that you wish to run, and install them to your binaries path.

  • Default Path: $HOME/privateer/bin
  • Customize via CLI: Use --binaries-path in your CLI command to change the path to your binaries.
  • Customize via config: Specify a custom binaries path in your config via the top level value binaries-path: your/bin/path

Configuration

  1. Create a Configuration File: Craft a configuration file (e.g., config.yml) that specifies the raids you intend to run and any necessary configuration options. Include secrets and settings required by the raid. Refer to the specific raid's documentation for precise details.
  2. Output Directory (Optional): If desired, define an output directory in your configuration. Privateer will generate log and result files for each raid in this directory. Results files are available in both JSON and YAML formats.
  3. Advanced Config Management: Privateer's roadmap includes plans for integrating with systems like etcd and Consul to enhance configuration and secret management.

Note

If your configuration file is stored in a non-default location, specify its file path using the -c or --config flag.

Example Config.yml

loglevel: trace
WriteDirectory: test_output
binaries-path: your/bin/path
Raids:
  Wireframe:
    JokeName: Jimmy

Common Commands

Here are some common commands you can use with Privateer:

  • -h / --help: Display help information about Privateer and its commands.
  • sally: Execute the specified raid(s).
  • generate-raid: Automatically create the code for a raid based on a FINOS Common Cloud Controls catalog.
  • list: Show raids requested by your configuration and whether they're installed.
    • list -a: Show all raids you have installed.

Output Customization

Privateer generates logs and results files for each raid. The output location may be specified by -o / --output-dir.

  • Log Results: <output_dir>/<raid_name>/<raid_name>.log
  • Raid Results: <output_dir>/<raid_name>/results.yaml
  • Default Value: $HOME/privateer/output

Tailoring Verbosity

  • Log Verbosity: Increase the verbosity of logs using the -v or --verbose flag.
  • Silence Logs: Silence non-essential log information using the -s or --silent flag.