-
Notifications
You must be signed in to change notification settings - Fork 787
Control Center Policies #11233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NicoletaComan
wants to merge
12
commits into
development
Choose a base branch
from
nc-policies
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Control Center Policies #11233
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
b44d0f9
Added page to structure
NicoletaComan 90d5cb5
Merge remote-tracking branch 'origin/development' into nc-cc-policies
NicoletaComan 5101f6b
Added the Control Center part of Policies
NicoletaComan d2e931c
Added the Software Composition part of Policies
NicoletaComan f5fd697
X-linking + RN
NicoletaComan df0c2e4
Added Deployment RN
NicoletaComan e4a283b
Updated release date + removed beta label
NicoletaComan 5003774
Merge remote-tracking branch 'origin/development' into nc-policies
NicoletaComan 88f3b88
Fixed typo
NicoletaComan ec01751
Changed release date
NicoletaComan ca497c1
Merge remote-tracking branch 'origin/development' into nc-policies
NicoletaComan 2b46802
Moved RN to new page
NicoletaComan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| --- | ||
| title: "Policies" | ||
| url: /control-center/policies/ | ||
| description: "Describes the Policies page in the Mendix Control Center." | ||
| weight: 30 | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Policies help ensure that your app landscape is secure, compliant, and consistent. On the **Policies** page, you can define policies that your apps need to adhere to. If they do not, violations are automatically detected and reported in Software Composition, allowing you to react accordingly. For details on how policy violations are displayed in Software Composition, refer to [Policy Status](/control-center/policy-status/). | ||
|
|
||
| The **Policies** page allows you to create new policies, lists all of your existing policies, and displays a **Help & Support** pane with useful information about creating policies. | ||
|
|
||
| ## Defining Policies | ||
|
|
||
| You can define policies by either using a template or starting from scratch. The following sections describe the process for each scenario. | ||
|
|
||
| ### Creating a Policy From a Template | ||
|
|
||
| You can use one of the existing templates to create your own policy. | ||
|
|
||
| 1. Click **Create from Template**. | ||
|
|
||
| 2. Select one of the available templates: | ||
|
|
||
| * Don’t allow high or critical findings | ||
| * Don’t allow Mendix runtime versions below 9.24.26 | ||
| * Only allow Marketplace components that are platform-supported | ||
|
|
||
| 3. In the **Policy Name** field, add a name for the new policy. | ||
|
|
||
| 4. Select one of these actions: | ||
|
|
||
| * **Edit** – Make changes to the template, such as adjusting the Mendix runtime version. | ||
| * **Save as Inactive** – Save the policy, but do not enforce it yet. | ||
| * **Save & Activate** – Save the policy and enforce it. | ||
|
|
||
| ### Creating a Policy From Scratch | ||
|
|
||
| You can create a policy by defining your own details. | ||
|
|
||
| 1. Click **Create from Scratch**. | ||
|
|
||
| 2. On the **Policy Definition** tab, fill in the following details: | ||
|
|
||
| * **Policy Name** – A relevant name for your policy, such as one indicating what the policy checks. | ||
| * **Description** – A description of the goal of the policy, which covers why it needs to be adhered to, and how to fix its violations. | ||
| * **Policy Conditions** – Define the conditions under which the policy is considered violated. These are the available conditions and their values: | ||
|
|
||
| * **Any finding severity is** – Choose which severity level violates the policy. You can select one or more of the following values: | ||
|
|
||
| * **LOW** | ||
| * **MEDIUM** | ||
| * **HIGH** | ||
| * **CRITICAL** | ||
|
|
||
| For example, if you select **CRITICAL**, apps with critical findings violate this policy. | ||
|
|
||
| * **Mendix runtime version is lower than** – Indicate which Mendix version is the minimum that your apps must use. | ||
|
|
||
| * **Marketplace component license is not** – Select the licenses that are acceptable. If a Marketplace component has a license which is not one of the ones you select here, the policy is violated. These are the possible values: | ||
|
|
||
| * MIT | ||
| * BSD_2_0 | ||
| * APACHE_V2 | ||
| * APACHE_1_0 | ||
| * MENDIX_EULA | ||
| * PARTNER_LICENSES | ||
| * CREATIVE_COMMONS_CC0 | ||
| * GNU_GENERAL_PUBLIC_LICENSE_V3 | ||
| * MENDIX_MARKETPLACE_CONTENT_TERMS | ||
|
|
||
| * **Marketplace component support is not** – Select the support types that are acceptable. If a Marketplace component has a support type which is not one of the ones you select here, the policy is violated. These are the possible values: | ||
|
|
||
| * PARTNER | ||
| * SIEMENS | ||
| * PLATFORM | ||
| * COMMUNITY | ||
|
|
||
| * **Checkpoints & Action(s)** – Select the trigger which causes the policy to be checked, and the action that is taken if the policy is violated. Currently, policy violations are checked at the time of package creation, and violations generate warnings. | ||
|
|
||
| 3. On the **Policy Scope** tab, select whether you want the policy to apply to all licensed apps, or only to specific apps in your environment. | ||
|
|
||
| 4. Select one of these actions: | ||
|
|
||
| * **Cancel** – Discard the policy. | ||
| * **Save as Inactive** – Save the policy, but do not enforce it yet. | ||
| * **Save & Activate** – Save the policy and enforce it. | ||
|
|
||
| ## Policy Details | ||
|
|
||
| These are the details you can see for every existing policy: | ||
|
|
||
| * **Policy Name** – The policy's name. | ||
| * **ID** – The policy's unique ID, which you can copy. | ||
| * **Policy Scope** – The policy's app scope. | ||
| * **Last Updated By** – The unique ID of the user who most recently updated the policy. | ||
| * **Last Updated Date** – The date when the policy was most recently updated. | ||
| * **Status** – Whether the policy is active or not. | ||
| * Actions: | ||
|
|
||
| * **Edit Policy** | ||
| * **Deactivate Policy** | ||
| * **Delete Policy** |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
content/en/docs/control-center/security/software-composition/policy-status.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: "Policy Status Tab" | ||
| url: /control-center/policy-status/ | ||
| description: "Describes the Policy Status tab on the Software Composition page of the Mendix Control Center." | ||
| weight: 3 | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| The **Policy Status** tab lists the policies that apply to all apps in your landscape, along with the number of times each policy was violated. Clicking a policy name opens the list of all apps and environments which violated that specific policy, with the following details: | ||
|
|
||
| * **Status** – The type of violation. | ||
| * **App Name** – The name of the app which violated the policy. | ||
| * **Package Name** – The name of the package which violated the policy. | ||
| * **Environment Name** – If applicable, the name of the environment where the violating app package is deployed. | ||
| * **Runtime** – The runtime version of the deployment package. | ||
| * **Target Cloud** — The type of cloud where the deployment package is deployed. | ||
|
NicoletaComan marked this conversation as resolved.
|
||
| * **Last Checked On** – The date when the policy was last checked. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.