open-nomad/command/sentinel.go

// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package command

import (
	"strings"

	"github.com/mitchellh/cli"
)

type SentinelCommand struct {
	Meta
}

func (f *SentinelCommand) Help() string {
	helpText := `
Usage: nomad sentinel <subcommand> [options] [args]

  This command groups subcommands for interacting with Sentinel policies.
  Sentinel policies allow operators to express fine-grained policies as code and
  have their policies automatically enforced. This allows operators to define a
  "sandbox" and restrict actions to only those compliant with policy. The
  Sentinel integration builds on the ACL System. Users can read existing
  Sentinel policies, create new policies, delete and list existing policies, and
  more. For a full guide on Sentinel policies see:
  https://www.nomadproject.io/guides/sentinel-policy.html

  Read an existing policy:

      $ nomad sentinel read <name>

  List existing policies:

      $ nomad sentinel list

  Create a new Sentinel policy:

      $ nomad sentinel apply <name> <path>

  Please see the individual subcommand help for detailed usage information.
`

	return strings.TrimSpace(helpText)
}

func (f *SentinelCommand) Synopsis() string {
	return "Interact with Sentinel policies"
}

func (f *SentinelCommand) Name() string { return "sentinel" }

func (f *SentinelCommand) Run(args []string) int {
	return cli.RunResultHelp
}