Skip to content

Commit

Permalink
Merge pull request #862 from mandy-chessell/dev-dojo
Browse files Browse the repository at this point in the history
Rename GovernanceAciton to EngineAction
  • Loading branch information
mandy-chessell authored Nov 20, 2023
2 parents 6325001 + b71ffe5 commit 9f3bde1
Show file tree
Hide file tree
Showing 77 changed files with 8,292 additions and 349 deletions.
36 changes: 36 additions & 0 deletions site/docs/concepts/engine-action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
hide:
- toc
---

<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the ODPi Egeria project. -->


# Engine Action

An *engine action* describes a specific invocation of a [governance service](/concepts/governance-service) that needs to be performed on one or more metadata elements, or their counterparts in the digital landscape.

An engine action is represented by an [*EngineAction*](/types/4/0463-Engine-Actions) entity in the open metadata ecosystem. It contains details such as:

* The [governance request type](/concepts/governance-request-type) that identifies which governance service to call.
* The request parameters that provide parameters to the governance service.
* The [governance engine](/concepts/governance-engine) that will run the [governance service](/concepts/governance-service).

It is linked to:

* The source (cause) of the engine action, such as an [incident report](/concepts/incident-report).
* Any additional target elements that need to be acted upon.

This *EngineAction* metadata entity is used to coordinate the desired activity in the governance engine, record its current state and act as a record of the activity for future audits.

Engine actions can be created through the [Open Governance Service API](/services/gaf-metadata-management). Some governance services (for example, the [Watchdog Governance Action Service](/guides/developer/governance-action-services/watchdog-governance-service)) can initiate other engine actions directly.

Governance services produce output strings called [*guards*](/concepts/guard) that indicate specific conditions or outcomes. These guards can be used to trigger new engine actions. The choreography of which engine action to run next based on the outcome of an engine action is defined in a [Governance Action Process](/concepts/governance-action-process). Triggered engine actions are linked to their predecessor, so it is possible to trace through which engine actions ran, and why.

If the start date of the engine action is in the future, the [Engine Host Services](/services/engine-host-services) running in the same [Engine Host](/concepts/engine-host) OMAG Server as the nominated governance engine will schedule the governance service to run soon after the requested start date. If the start date is left blank, the requested governance service is run as soon as possible.

!!! tip "*Governance Action* was renamed to *Engine Action* in release 4.4"
If you have been using Egeria for a while, you may be familiar with the term *Governance Action* as the mechanism used to control the execution of automated actions in the Engine Hosts. In [release 4.4](/release-notes/4-4), *Governance Action* was renamed to *Engine Action* to create a greater name differentiation between the concepts that are used to define the governance behaviour and those used to control the execution of this behaviour.

--8<-- "snippets/abbr.md"
12 changes: 6 additions & 6 deletions site/docs/concepts/governance-action-process-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- Copyright Contributors to the ODPi Egeria project. -->


A *governance action process* is a predefined sequence of [governance actions](/concepts/governance-action) that are coordinated by the [Governance Engine OMAS](/services/omas/governance-engine/overview).
A *governance action process* is a predefined sequence of [engine actions](/concepts/engine-action that are coordinated by the [Governance Engine OMAS](/services/omas/governance-engine/overview).

The steps in a governance action process are defined by linked [governance action types](/concepts/governance-action-type) stored in the open metadata ecosystem. Each governance action type provides the specification of the governance action to run. The links between them show which [guards](/concepts/guard) cause the governance action to run.
The steps in a governance action process are defined by linked [governance action process steps](/concepts/governance-action-process-step) stored in the open metadata ecosystem. Each governance action process step provides the specification of the governance action to run. The links between them show which [guards](/concepts/guard) cause the next step to be chosen and hence, the governance action to run.

The governance action process support enables governance professionals to assemble and monitor governance processes without needing to be a Java programmer.

Expand All @@ -31,20 +31,20 @@ Example 2 shows an [open discovery service](/concepts/open-discovery-service) am
## Capturing lineage for a governance action process

The [governance actions](/concepts/governance-action) generated when a governance action process runs provide a complete audit trace of the governance services that ran and their results. The [Governance Action Open Lineage Integration Connector](/connectors/integration/governance-action-open-lineage-integration-connector) is able to monitor the operation of the governance actions and produce [OpenLineage events](/features/lineage-management/overview/#the-openlineage-standard) to provide operational lineage for governance action processes. Egeria is also able to [capture these events](/connectors/#capturing-and-publishing-lineage) (along with OpenLineage events from other technologies) for later analysis.
The [engine actions](/concepts/engine-action generated when a governance action process runs provide a complete audit trace of the governance services that ran and their results. The [Governance Action Open Lineage Integration Connector](/connectors/integration/governance-action-open-lineage-integration-connector) is able to monitor the operation of the governance actions and produce [OpenLineage events](/features/lineage-management/overview/#the-openlineage-standard) to provide operational lineage for governance action processes. Egeria is also able to [capture these events](/connectors/#capturing-and-publishing-lineage) (along with OpenLineage events from other technologies) for later analysis.

## Governance Action Process Lifecycle

The diagram below shows a governance action process assembly tool taking in information from a [governance engine pack](/concepts/governance-engine-pack) to build a governance action process flow. This is shared with the open metadata ecosystem either through direct called to the [Governance Engine OMAS](/services/omas/governance-engone/overview) or via a [open metadata archive](/concepts/open-metadata-archive) (possibly the archive that holds the governance engine definition.

Once the definition of the governance action process is available, an instance of the process can be started, either by a [watchdog governance action service](/concepts/governance-action-service) or through a direct call to the Governance Engine OMAS. Whichever mechanism is used, it results in the Governance Engine OMAS using the definition to choreograph the creation of [governance action](/concepts/governance-action) entities that drive the execution of the governance services in the [Engine Host](/concepts/engine-host).
Once the definition of the governance action process is available, an instance of the process can be started, either by a [watchdog governance action service](/concepts/governance-action-service) or through a direct call to the Governance Engine OMAS. Whichever mechanism is used, it results in the Governance Engine OMAS using the definition to choreograph the creation of [engine action](/concepts/engine-action entities that drive the execution of the governance services in the [Engine Host](/concepts/engine-host).

![Lifecycle](/concepts/governance-action-process-lifecycle.svg)


!!! education "Further information"
- The [0462 Governance Action Types](/types/4/0462-Governance-Action-Types) model shows how the governance action process flow is built out of [governance action types](/concepts/governance-action-type).
- The [0462 Governance Action Processes](/types/4/0462-Governance-Action-Processes) model shows how the governance action process flow is built out of [governance action process steps](/concepts/governance-action-process-step).
- Governance action processes may be created using the [Governance Engine OMAS](/services/omas/governance-engine/overview) API.
- The [Open Metadata Engine Services (OMES)](/services/omes) provide the mechanisms that support the different types of [governance engines](/concepts/governance-engine). These engines run the [governance services](/concepts/governance-service) that execute the [governance actions](/concepts/governance-action) defined by the governance action process.
- The [Open Metadata Engine Services (OMES)](/services/omes) provide the mechanisms that support the different types of [governance engines](/concepts/governance-engine). These engines run the [governance services](/concepts/governance-service) that execute the [engine actions](/concepts/engine-action defined by the governance action process.


11 changes: 11 additions & 0 deletions site/docs/concepts/governance-action-process-step.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the ODPi Egeria project. -->


# Governance Action Process Step

A *governance action process step* is a step in a [governance action process](/concepts/governance-action-process). The *governance action process steps* are linked together form a graph that shows the flow of actions that should be performed when a [governance action process](/concepts/governance-action-process) runs.

Governance action process steps are defined and linked into a governance action process flow through the [Open Governance Service](/services/gaf-metadata-management). Behind the scenes, this flow is stored using metadata elements described in [0462 Governance Action Processes](/types/4/0462-Governance-Action-Processes).

--8<-- "snippets/abbr.md"
9 changes: 1 addition & 8 deletions site/docs/concepts/governance-action-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@

# Governance Action Type

A *governance action type* is a template for a [governance action](/concepts/governance-action). A set of linked governance action types form the definition of a [governance action process](/concepts/governance-action-process).

Governance action types are defined through the [Governance Engine OMAS](/services/omas/governance-engine/overview) and this OMAS also coordinates the creation of a governance action from the governance action type as part of its execution of the governance action process.

## Open metadata type definition

The governance action type is defined in the [0462 Governance Action Type](/types/4/0462-Governance-Action-Types) model of the Open Metadata Types.

Governance Action Type has been renamed to [Governance Action Process Step](/concepts/governance-action-process-step)

--8<-- "snippets/abbr.md"
24 changes: 1 addition & 23 deletions site/docs/concepts/governance-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,6 @@ hide:

# Governance Action

A *governance action* describes a specific invocation of a [governance service](/concepts/governance-service) that needs to be performed on one or more metadata elements, or their counterparts in the digital landscape.

A governance action is represented by a [*GovernanceAction*](/types/4/0463-Governance-Actions) entity in the open metadata ecosystem. It contains details such as:

* The [governance request type](/concepts/governance-request-type) that identifies which governance action to run.
* The request parameters that provide parameters to the governance service.
* The [governance engine](/concepts/governance-engine) that will run the [governance service](/concepts/governance-service).

It is linked to:

* The source (cause) of the governance action, such as an [incident report](/concepts/incident-report).
* Any additional target elements that need to be acted upon.

This *GovernanceAction* metadata entity is used to coordinate the desired activity in the governance engine, record its current state and act as a record of the activity for future audits.

Governance actions can be created through the [Governance Engine OMAS API](/services/omas/governance-engine/overview). Some governance services (for example, the [Watchdog Governance Action Service](/guides/developer/governance-action-services/watchdog-governance-service)) can initiate other governance actions.

Governance services produce output strings called [*guards*](/concepts/guard) that indicate specific conditions or outcomes. These guards can be used to trigger new governance actions. Triggered governance actions are linked to their predecessor, so it is possible to trace through the governance actions that ran.

The [governance action process](/concepts/governance-action-process) defines the flow of governance actions. It uses [governance action types](/concepts/governance-action-type) to build up a template of possible governance actions linked via the guards. When the process runs, its linked governance action types control the triggering of new governance actions.

If the start date of the governance action is in the future, the [Engine Host Services](/services/engine-host-services) running in the same [Engine Host](/concepts/engine-host) OMAG Server as the nominated governance engine will schedule the governance service to run soon after the requested start date. If the start date is left blank, the requested governance service is run as soon as possible.

The governance action has been renamed to [Engine Action](/concepts/engine-action).

--8<-- "snippets/abbr.md"
2 changes: 1 addition & 1 deletion site/docs/concepts/governance-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When a governance engine is called, it is passed a [governance request type](/co
The unique name of the governance engine defined in the governance engine definition is added to the [OMES configuration](/guides/admin/servers/configuring-an-engine-host/#configure-engine-service). When the [engine host](/concepts/engine-host) starts up the OMES, it reads the *governance engine definition* from its partner [metadata access server](/concepts/metadata-access-server) to complete its initialization. The engine host monitors changes in the governance engine definition so the services within the governance engine can be dynamically maintained.

Calls to the governance engine are made by creating [governance actions](/concepts/governance-action) in the open metadata ecosystem. The engine host is monitoring for new governance actions for the governance engine. When one occurs, it claims the governance action and passes on the request to the governance engine to run. The claim process is used since there may be multiple engine hosts running that governance engine and only one of them should process the request.
Calls to the governance engine are made by creating [engine actions](/concepts/engine-action in the open metadata ecosystem. The engine host is monitoring for new governance actions for the governance engine. When one occurs, it claims the governance action and passes on the request to the governance engine to run. The claim process is used since there may be multiple engine hosts running that governance engine and only one of them should process the request.

![Calling a governance engine](governance-engine-call.svg)
> A governance action can be created anywhere in the open metadata ecosystem. The result is an event that is passed via its connected metadata access server to the engine host. If the request is for a governance engine that it is hosting, the engine host claims the governance action and passes the request to the governance engine.
Expand Down
4 changes: 2 additions & 2 deletions site/docs/concepts/governance-execution-point.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ A governance execution point is represented in open metadata by an [*ExecutionPo

The classifications *ControlPoint*, *VerificationPoint* and *EnforcementPoint* are used to label entities describing implementation components such as [Processes](/types/0/0010-Base-model) with the type of execution point and the qualified name of the corresponding definition if any. They are often found on elements such as:

* [Governance Action Types](/types/4/0462-Governance-Action-Types)
* [Governance Actions](/types/4/0463-Governance-Actions)
* [Governance Action Process Steps](/types/4/0462-Governance-Action-Processes)
* [Engine Actions](/types/4/0463-Engine-Actions)

These classifications can be used to drive additional audit logging when the implementation component is running. Logging information about the activities of these components with the qualifiedName of the execution point definition makes it easier to correlate the activity with the governance definitions.

Expand Down
2 changes: 1 addition & 1 deletion site/docs/concepts/governance-request-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When the governance engine is called with the request type, the governance engin

!!! education "Further information"
* The Open Metadata Types model *[0461 Governance Action Engines](/types/4/0461-Governance-Engines)* shows how the governance request type links the governance engine to the governance service via the *SupportedGovernanceService* relationship.
* [Building governance action services](/guides/developer/governance-action-services/overview) describes how the governance request type, request parameters and action types are passed to a governance action service.
* [Building governance action services](/guides/developer/governance-action-services/overview) describes how the governance request type, request parameters and target actions are passed to a governance action service.



Expand Down
2 changes: 1 addition & 1 deletion site/docs/concepts/guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Guards are labels that are created by [governance services](/concepts/governance-service)
and are used by the [Governance Engine OMAS](/services/omas/governance-engine/overview) to
determine which [governance action](/concepts/governance-action) to run next.
determine which [engine action](/concepts/engine-action to run next.


--8<-- "snippets/abbr.md"
8 changes: 5 additions & 3 deletions site/docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@

- [Endpoint](/concepts/endpoint)
- [Engine](/concepts/software-capability/#engine)
- [Engine Action](/concepts/engine-action)
- [Engine Host](/concepts/engine-host)
- [Enterprise Metadata Collection](/concepts/metadata-collection)
- [Enterprise Repository Services Subsystem (OMRS)](/services/omrs)
Expand Down Expand Up @@ -146,12 +147,13 @@
- [Glossary](/practices/common-data-definitions/anatomy-of-a-glossary)
- [Glossary Category](/practices/common-data-definitions/anatomy-of-a-glossary/#glossary-categories)
- [Glossary Term](/practices/common-data-definitions/anatomy-of-a-glossary/#inside-a-glossary-term)
- [Governance Action](/concepts/governance-action)
- [Governance Action](/concepts/engine-action)
- [Governance Action Engine](/concepts/governance-action-engine)
- [Governance Action OMES](/service/omes/governance-action/overview)
- [Governance Action Framework (GAF)](/frameworks/gaf/overview)
- [Governance Action Process](/concepts/governance-action-type)
- [Governance Action Type](/concepts/governance-action-process)
- [Governance Action Process](/concepts/governance-action-process)
- [Governance Action Process Step](/concepts/governance-action-process-step)
- [Governance Action Type](/concepts/governance-action-process-step)
- [Governance Domain](/concepts/governance-domain)
- [Governance Domain Identifier](/concepts/governance-domain)
- [Governance Engine](/concepts/governance-engine)
Expand Down
Loading

0 comments on commit 9f3bde1

Please sign in to comment.