Skip to content

Commit

Permalink
Merge branch 'main' into connectgraddoc
Browse files Browse the repository at this point in the history
  • Loading branch information
planetf1 authored Jan 3, 2023
2 parents 36ab405 + a0d5a91 commit 431d717
Show file tree
Hide file tree
Showing 35 changed files with 219 additions and 138 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/merge-mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ jobs:
- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: pip install mkdocs-material==8.5.3
- run: mkdocs gh-deploy --force
working-directory: ./site
2 changes: 1 addition & 1 deletion .github/workflows/pr-mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ jobs:
- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: pip install mkdocs-material==8.5.3
- run: mkdocs build
working-directory: ./site
4 changes: 4 additions & 0 deletions site/docs/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ Egeria is pleased to announce integration with the following technologies:
* OpenLineage
* OpenAPISpecification
* Apache Avro
* Apache Parquet
* MariaDB
* Trino
* Apache Directory


!!! info "Further Information"
Expand Down
19 changes: 10 additions & 9 deletions site/docs/guides/operations/kubernetes/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

In Kubernetes, resources such as pods (to run code) or services (for network accessibility) are defined in YAML. One or more documents can be submitted at a time.

So we might have one YAML file that defines our pod - with information about which container images to run, and another to setup a network service. Finally, we may have another that describes our storage requirements (a persistent volume claim).
So we might have one YAML file that defines our pod - with information about which container images to run, and another to set up a network service. Finally, we may have another that describes our storage requirements (a persistent volume claim).

## What does Helm do?

Expand Down Expand Up @@ -120,24 +120,25 @@ And you can then install (deploy) a chart:
In a helm chart the configuration that has been externalised by the chart writer is specified in the `values.yaml` file which you can find in this directory. However rather than edit this file directly, it's recommended you create an additional file with the required overrides.

As an example, in `values.yaml` we see a value 'serverName' which is set to mds1. If I want to override this I could do

!!! cli "Install a chart with additional properties set"
```console
helm install --set-string egeria.serverName=myserver <release> egeria/<chart>
```
```console
helm install --set-string egeria.serverName=myserver <release> egeria/<chart>
```

However this can get tedious with multiple values to override, and you need to know the correct types to use.
However, this can get tedious with multiple values to override, and you need to know the correct types to use.

Instead it may be easier to create an additional file. For example let's create a file in my home directory `~/egeria.yaml` containing:
Instead, it may be easier to create an additional file. For example let's create a file in my home directory `~/egeria.yaml` containing:
```yaml
egeria:
serverName: metadataserver
viewServerName: presentationview
```
!!! cli "Install a chart with additional properties in a modified yaml"
```console
helm install -f ~/egeria.yaml metadataserver egeria/egeria-base
```
```console
helm install -f ~/egeria.yaml metadataserver egeria/egeria-base
```

You can find out all the configurable values for a chart by running:

Expand Down
48 changes: 24 additions & 24 deletions site/docs/guides/operations/kubernetes/k8s-cmds.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,44 +6,44 @@
This page gives a few example of useful commands.

!!! cli "List running pods"
```console
kubectl get pods
```
```console
kubectl get pods
```

!!! cli "list active services"
```console
kubectl get pods
```
```console
kubectl get pods
```

!!! cli "list all active resources"
```console
kubectl get all
```
```console
kubectl get all
```

!!! cli "Get more details on a pod"
```console
kubectl describe pods <pod-id>
```
```console
kubectl describe pods <pod-id>
```

!!! cli "get logs from a pod"
```console
kubectl logs <pod-id>
```
```console
kubectl logs <pod-id>
```

!!! cli "kill a pod"
```console
kubectl delete pod <pod-id>
```
```console
kubectl delete pod <pod-id>
```

!!! cli "setup port forwarding for a pod"
```console
kubectl port-forward pod/<pod-id> <local-port>:<remote-port>
```
```console
kubectl port-forward pod/<pod-id> <local-port>:<remote-port>
```

!!! cli "setup port forwarding for a service"
```console
kubectl port-forward service/<pod-id> <local-port>:<remote-port>
```
```console
kubectl port-forward service/<pod-id> <local-port>:<remote-port>
```


---8<-- "snippets/abbr.md"
4 changes: 2 additions & 2 deletions site/docs/guides/operations/kubernetes/k8s-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you still see issues, contact the [Rancher desktop community](https://github.

![Rancher Error Starting Kubernetes](rancher-starterror.png)

![Kubernetes Setttings](rancherprefs.png)
![Kubernetes Settings](rancherprefs.png)

Also ensure the following symbolic links are set up for helm & kubectl. If you are only using Rancher it's recommended to enable all the links.

Expand Down Expand Up @@ -143,7 +143,7 @@ Ensure when installing you specify at least 6GB RAM.

## [Docker Desktop](https://www.docker.com/products/docker-desktop){ target=docker } (Windows, MacOS)

!!!attention Licensing Changes for Docker Desktop
!!! attention "Licensing Changes for Docker Desktop"
Docker has recently updated their licensing conditions for Docker Desktop.

As such, it is therefore no longer our preferred/tested environment for Dojos.
Expand Down
5 changes: 4 additions & 1 deletion site/docs/release-notes/3-15.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The notes will be updated until & when 3.15 is released**_
* A new attribute called *waitTime* has been added to the [*GovernanceActionType*](/types/4/0462-Governance-Action-Types) entity type to allow delays to be added into a process definition.
* A new attribute called *completionMessage* has been added to the [*GovernanceAction*](/types/4/0463-Governance-Action) entity type to allow a message from the governance service on the results of the action or the reasons why it failed.
* A new attribute called *completionMessage* has been added to the [*TargetForAction*](/types/4/0463-Governance-Action) relationship type to allow a message from the governance service on the results of the processing the target or the reasons why it failed.

* Appropriate properties have been added to the [*DigitalProduct*](/types/7/0710-Digital-Service) classification. These were missing from its original definition in release 3.13.
* A new relationship called [*DigitalServiceProduct*](/types/7/0710-Digital-Service) links a *DigitalService* to a *DigitalProduct*.
* The [*DigitalServiceOperator*](/types/7/0715-Digital-Service-Ownership) can now be any *Referenceable* rather than being restricted to a *Team*.
* The [*SolutionLinkingWire*](/types/7/0735-Solution-Ports-and-Wires) relationship can link any *Referenceable* rather than being restricted to a *SolutionPort*. This means that solution ports can be wired to [DigitalProducts](/types/7/0710-Digital-Service) and other artifacts that they interact with.

--8<-- "snippets/abbr.md"
7 changes: 3 additions & 4 deletions site/docs/release-notes/3-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,10 @@
None.

???+ bugs "Bug fixes and other updates"

*
For details, see the [commit history in GitHub :material-dock-window:](https://github.com/odpi/egeria/commits){ target=gh }.
* For details, see the [commit history in GitHub :material-dock-window:](https://github.com/odpi/egeria/releases/tag/V3.5){ target=gh }.

??? status "Implementation status"
[![Egeria implementation status](latest.svg)](../roadmap)
* ![Egeria implementation status](latest.svg)
* [Roadmap](../roadmap)

--8<-- "snippets/abbr.md"
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/release-notes/egeria-status.drawio

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/release-notes/functional-organization.svg
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 431d717

Please sign in to comment.