Skip to content

Commit

Permalink
Merge pull request #931 from mandy-chessell/code2024
Browse files Browse the repository at this point in the history 
Add missing properties to ResourceProfileAnnotation
  • Loading branch information
@mandy-chessell
mandy-chessell authored May 27, 2024
2 parents d240716 + 5d3df32 commit 8a3f090
Show file tree
Hide file tree
Showing 11 changed files with 233 additions and 44 deletions.
5 changes: 5 additions & 0 deletions site/docs/content-packs/cim-content-pack/overview.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- toc
---

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

Expand Down
5 changes: 5 additions & 0 deletions site/docs/content-packs/simple-content-pack/overview.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- toc
---

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

Expand Down
5 changes: 5 additions & 0 deletions site/docs/content-packs/types-content-pack/overview.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- toc
---

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

Expand Down
2 changes: 1 addition & 1 deletion site/docs/guides/planning/four-layers-of-choice.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 18 additions & 6 deletions site/docs/guides/planning/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

# Planning Guide

Egeria is highly modular, allowing you to choose which parts to use as supplied, and which to remove, extend, or replace with something customized for your organization.
Egeria is highly modular, allowing you to choose which components to use "as supplied", and which to remove, extend, or replace with something customized for your organization.
Typically, Egeria's function is broader than you need, at least initially, so often the challenge is to know which pieces you need to do the things you want to do, and what you can safely ignore.

There are four types of "content" from Egeria that you need to consider: Content Packs, Connectors, Configuration and the Runtime Libraries.
There are four types of "component" from Egeria that you need to consider: Content Packs, Connectors, Configuration and the Runtime Libraries.

![Four layers of content](four-layers-of-choice.svg)

Expand All @@ -15,22 +15,34 @@ There are four types of "content" from Egeria that you need to consider: Content
* The *configuration* controls the activation of Egeria's services in the runtime. Related services are grouped together into what are called [OMAG Servers](/concepts/omag-server) so they can be activated and deactivated together. Egeria's services are used to build out your knowledge graph. They can be called from the connectors, or other tools and technologies using Egeria's clients, or directly via the REST APIs. Managing configuration is described in the [Administration Guide](/guides/admin).
* The *runtime libraries* provide the services to manage the connectors and the knowledge graph. They are packaged into a choice of two runtimes. The [OMAG Server Platform](/concepts/omag-server-platform) is the typical runtime to use, particularly initially, since it can run all functions using multiple OMAG Servers and its configuration can be dynamically changed making it easy to experiment with different settings. The [OMAG Server Runtime](/concepts/omag-server-runtime) is a specialist runtime for a cloud-native deployment that only runs a single OMAG Server using a fixed configuration. The specific software services included in either runtime can be both removed or added at build time to allow you to fully customize Egeria's runtimes.

The *Planning Guide* provides information to help you plan the deployment of Egeria in your organization. As a general rule of thumb, we suggest using the content as supplied and only customize it as you get more confident. To this end, when you build the main egeria repository ([egeria.git]()), it creates a distribution folder containing content packs, connectors, sample configuration and the runtime libraries along with `README.md` files describing how to use this content. The Egeria project also includes additional content, such as connectors, in other repositories that can be built and added to this distribution. The distribution also includes a Docker script file so that, once you have all of the content you need assembled, it can be turned into a docker container for deployment. Alternatively it can be run directly on a local machine running Linux or MacOS (bare metal).
The *Planning Guide* provides information to help you plan the deployment of Egeria in your organization.

## Egeria's distribution

The *Planning Guide* is divided into two parts as follows:
As a general rule of thumb, we suggest using Egeria's components as supplied and only customize them as you get more confident. To this end, when you [build the main egeria repository](/education/tutorials/building-egeria-tutorial/overview) (called [egeria.git](https://github.com/odpi/egeria)), it creates a distribution folder containing content packs, connectors, sample configuration and the runtime libraries along with `README.md` files describing how to use this content.

--8<-- "snippets/inside-egerias-distribution.md"

The Egeria project also includes additional content, such as connectors, in other repositories that can be built and added to this distribution. The distribution also includes a Docker script file so that, once you have all of the content you need assembled, it can be turned into a docker container for deployment. Alternatively it can be run directly on a local machine running Linux or MacOS (bare metal).


## Designing your own deployment

The rest of this *Planning Guide* assumes you are familiar with the basic concepts of Egeria and have some knowledge of the contents of the Egeria's distribution. It aims to guide you through the process if customizing your Egeria deployment. It is divided into two parts as follows:

* *Planning Deployment* focuses on the setting up of the Egeria software and its supporting technology

* [Planning Runtime Deployment](/guides/planning/runtime/overview) describes how to design your Egeria runtime deployment.
* [Designing your security model](/guides/planning/security/overview) describes how to build a threat model for Egeria.
* [Planning User Interfaces](/guides/planning/user-interfaces) describes how to plan for the two user interfaces that Egeria supplies.

* *Preparing Metadata Ecosystem* describes the types of metadata that should be populated in your open metadata ecosystem to allow it to operate effectively.
* *Preparing Metadata Ecosystem* describes the types of metadata that should be populated in your open metadata ecosystem to allow it to operate effectively. This metadata can be added directly into your metadata repository, or added to your own content packs to load across multiple Egeria deployments.

* [Metadata Valid Values](/guides/planning/valid-values/overview) to control the values used in open metadata elements.
* [Multiple Language Translations](/guides/planning/translations/overview) to support multiple languages in the metadata elements.
* [Onboarding Organization](/guides/planning/organization/overview) to define the people, their roles and userIds and how they are organized into teams. This is used to control access to metadata and associated resources, route stewardship actions to the appropriate individuals/teams and synchronize organizational information between systems.
* [Governance Program](/guides/planning/governance-program/overview) to coordinate the various governance activities in the organization.


The connectors supplied by Egeria

--8<-- "snippets/abbr.md"
111 changes: 106 additions & 5 deletions site/docs/guides/planning/planning-guide.drawio
View file
Original file line number Diff line number Diff line change
@@ -1,25 +1,126 @@
<mxfile host="Electron" modified="2024-05-21T16:25:48.152Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.1.0 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="tfgaJ9QGfUZQx60fws8g" version="24.1.0" type="device">
<mxfile host="Electron" modified="2024-05-27T11:59:18.994Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.4.8 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="BFpe4meuo77ULNihCora" version="24.4.8" type="device" pages="2">
<diagram name="four-layers-of-choice" id="SAM_tC9CIVqK7PkyQRDT">
<mxGraphModel dx="1114" dy="941" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="9Qbzj7xQOk-ZIAOEFLsu-1" value="Content Packs" style="rounded=0;whiteSpace=wrap;html=1;align=left;spacingLeft=14;fillColor=#ffe6cc;strokeColor=#d79b00;" vertex="1" parent="1">
<mxGeometry x="230" y="310" width="390" height="60" as="geometry" />
<mxGeometry x="230" y="310" width="540" height="60" as="geometry" />
</mxCell>
<mxCell id="9Qbzj7xQOk-ZIAOEFLsu-2" value="Connectors" style="rounded=0;whiteSpace=wrap;html=1;align=left;spacingLeft=14;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
<mxGeometry x="230" y="380" width="390" height="60" as="geometry" />
<mxGeometry x="230" y="380" width="540" height="60" as="geometry" />
</mxCell>
<mxCell id="9Qbzj7xQOk-ZIAOEFLsu-3" value="Configuration" style="rounded=0;whiteSpace=wrap;html=1;align=left;spacingLeft=14;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
<mxGeometry x="230" y="450" width="390" height="60" as="geometry" />
<mxGeometry x="230" y="450" width="540" height="60" as="geometry" />
</mxCell>
<mxCell id="9Qbzj7xQOk-ZIAOEFLsu-4" value="Runtime Libraries" style="rounded=0;whiteSpace=wrap;html=1;align=left;spacingLeft=14;fillColor=#d5e8d4;strokeColor=#82b366;" vertex="1" parent="1">
<mxGeometry x="230" y="520" width="390" height="60" as="geometry" />
<mxGeometry x="230" y="520" width="540" height="60" as="geometry" />
</mxCell>
<mxCell id="9Qbzj7xQOk-ZIAOEFLsu-6" value="What you want to do&lt;div&gt;(use cases)&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=none;verticalAlign=top;dashed=1;dashPattern=8 8;" vertex="1" parent="1">
<mxGeometry x="365" y="260" width="120" height="360" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
<diagram id="SO0MbRdAikPU8TopPgpa" name="sample-configs">
<mxGraphModel dx="2069" dy="1961" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="FpbwSX7cbqtlmRdAi0SY-21" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#6c8ebf;" parent="1" vertex="1">
<mxGeometry x="800" y="185" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-23" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#6c8ebf;" parent="1" vertex="1">
<mxGeometry x="800" y="265" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-25" value="" style="rounded=0;whiteSpace=wrap;html=1;strokeColor=#6c8ebf;" parent="1" vertex="1">
<mxGeometry x="442" y="324" width="20" height="20" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-17" value="" style="shape=corner;whiteSpace=wrap;html=1;rotation=-180;dx=40;dy=40;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
<mxGeometry x="420" y="164" width="420" height="200" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-14" value="OMAG Server Platform" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;verticalAlign=top;align=left;" parent="1" vertex="1">
<mxGeometry x="-14" y="90" width="800" height="220" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-1" value="&amp;nbsp; &amp;nbsp; simple-metadata-store" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;align=left;" parent="1" vertex="1">
<mxGeometry y="210" width="190" height="50" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-9" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;dashed=1;endArrow=none;endFill=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-2" target="FpbwSX7cbqtlmRdAi0SY-1" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-26" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.75;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;strokeColor=#6c8ebf;startArrow=none;startFill=0;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-2" target="FpbwSX7cbqtlmRdAi0SY-25" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-2" value="active-metadata-store" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
<mxGeometry x="310" y="210" width="190" height="50" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-3" target="FpbwSX7cbqtlmRdAi0SY-2" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-3" value="view-server" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" parent="1" vertex="1">
<mxGeometry x="310" y="90" width="190" height="50" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-7" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.25;entryDx=0;entryDy=0;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-5" target="FpbwSX7cbqtlmRdAi0SY-2" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-22" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;startArrow=classic;startFill=1;strokeColor=#6c8ebf;endArrow=none;endFill=0;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-5" target="FpbwSX7cbqtlmRdAi0SY-21" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-5" value="integration-daemon" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
<mxGeometry x="580" y="170" width="190" height="50" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-8" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.75;entryDx=0;entryDy=0;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-6" target="FpbwSX7cbqtlmRdAi0SY-2" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-24" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;startArrow=classic;startFill=1;strokeColor=#6c8ebf;endArrow=none;endFill=0;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-6" target="FpbwSX7cbqtlmRdAi0SY-23" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-6" value="engine-host" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;" parent="1" vertex="1">
<mxGeometry x="580" y="250" width="190" height="50" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-10" value="optional&lt;div&gt;cohort link&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="210" y="197" width="80" height="40" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-11" value="XTDB Metadata&lt;div&gt;Repository&lt;/div&gt;" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=7;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
<mxGeometry x="327" y="330" width="60" height="80" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-12" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.25;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;entryPerimeter=0;endArrow=none;endFill=0;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-2" target="FpbwSX7cbqtlmRdAi0SY-11" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-13" value="In Memory Repository" style="shape=cylinder3;whiteSpace=wrap;html=1;boundedLbl=1;backgroundOutline=1;size=5;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
<mxGeometry x="140" y="230" width="60" height="50" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-15" value="REST API" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="400" y="164" width="80" height="30" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-18" value="Apache Kafka Event Broker" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;rotation=0;" parent="1" vertex="1">
<mxGeometry x="570" y="329" width="170" height="30" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-28" value="REST API" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="530" y="220" width="80" height="30" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-30" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-29" target="FpbwSX7cbqtlmRdAi0SY-3" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-33" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0.25;entryY=0;entryDx=0;entryDy=0;" parent="1" source="FpbwSX7cbqtlmRdAi0SY-29" target="FpbwSX7cbqtlmRdAi0SY-14" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-29" value="External program or User Interface" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="345" y="-30" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-31" value="Open Metadata and&lt;div&gt;Governance Requests&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="480" y="40" width="140" height="40" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-32" value="REST API" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="400" y="50" width="80" height="30" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-34" value="REST API" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="190" y="45" width="80" height="30" as="geometry" />
</mxCell>
<mxCell id="FpbwSX7cbqtlmRdAi0SY-35" value="Operational&lt;div&gt;Requests&lt;/div&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="90" y="40" width="90" height="40" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
4 changes: 4 additions & 0 deletions site/docs/guides/planning/sample-configs.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion site/docs/types/6/0620-Resource-Profiling.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8a3f090

Please sign in to comment.