Use Harness Policy As Code For Secrets
Harness provides governance using Open Policy Agent (OPA), Policy Management, and Rego policies.
You can create the policy and apply it to all Secrets in your Account, Org, and Project. The policy is evaluated on Secret-level events like On Save, which occurs during Secret Creation and Updates. See Harness Governance Quickstart.
This topic describes how to add a Policy step to a Secret.
Before you begin
- Harness Governance Overview
- Harness Governance Quickstart.
- Policies use OPA authoring language Rego. For more information, see OPA Policy Authoring.
- The policies that can be enforced are currently restricted by the Harness entities supported by the OPA service.
Step 1: Add a Policy
In Harness, go to Account Settings.
Click Policies, and then click New Policy.
New Policy settings appear.
Enter a Name for your policy and click Apply.
Next, you need to add your policy. Enter your own Rego policy. For example:
input.secret.description = "Secret description"
Step 2: Add the Policy to a Policy Set
After you create your policy, you must add it to a Policy Set before applying it to your Secrets.
In Policies, click Policy Sets, then click New Policy Set.
The Policy Set settings appear.
In Name, enter the name of the Policy Set.
In Description, enter a description of the Policy Set.
In Entity type, select Secret.
In On what event should the Policy Set be evaluated, select On save.
Existing Secrets are not automatically updated with policies. Policies can be applied to Secrets only on a save when they are created or updated.In Policy evaluation criteria, click Add Policy.
Select Policy settings appear. Select the policy you want to use from the list.
Select the severity and action you want to apply when the policy isn’t adhered to. You can select one of the following
- Warn & continue - You will receive a warning if the policy is not met when the Secret is evaluated, but the Secret will be saved and you may proceed.
- Error and exit - You'll get an error and be exited without saving the Secret if the policy isn't met when the Secret is examined.
Click Apply, and then click Finish.
To enforce your Policy Set, toggle on the Enforced button.
Step 3: Apply the Policy to a Secret
After you have created your Policy Set, and added your policies to it, apply the policy to a Secret.
Let us look at an example.
You can add a Secret from any module in your Project in Project setup, or in your Organization, or Account Resources.
In Account Resources, click Secrets.
Click New Secret, and then click Text.
Enter all the required fields and click Save and Continue.
Based on your selection in the Policy Evaluation criteria, you will either receive a warning or an error.