Skip to main content

Installatie

  1. Introductie
  2. Publiceren
  3. Gebruiken als SAAS
  4. Lokaal Installeren

Introductie​

Je hebt geen lokale installatie van OpenCatalogi nodig om het te benutten. Met een GitHub-organisatie kun je eenvoudig openbare data toevoegen en weergeven via het federaal netwerk.

Publiceren​

Publiceren van Componenten​

De snelste manier is de repository-URL aanmelden via deze link

Een abonnement op het publiceren kan ook. Hierdoor wordt de repository door OpenCatlogi bekeken voor wijzigingen. Zie hieronder voor de instructies.

Om componenten (informatie) te publiceren op OpenCatalogi, bieden we een GitHub-workflow. Voeg simpelweg het workflow-bestand toe aan de repository die je wilt publiceren.

  1. Maak binnen de repository van uw component een directory aan met de naam .github (als u deze nog niet heeft).
  2. Maak binnen deze directory een map workflows aan, die zelf binnen een .github map hoort te zitten. Plaats daarin deze workflow.yaml.
  3. Commit en push het workflow-bestand naar jouw repository.

Lees meer over de configuratie-opties van de workflow.

Publiceren van Componenten

Publiceren van Organisatie​

Om organisatiegegevens te publiceren op OpenCatalogi, is er eveneens een GitHub-workflow beschikbaar. Voeg het workflow-bestand toe aan de .github-repository van de organisatie die je wilt publiceren.

  1. Maak binnen uw GitHub-organisatie een repository aan met de naam .github (als u deze nog niet heeft).
  2. Maak binnen deze repository een map workflows aan, die zelf binnen een .github map hoort te zitten. Plaats daarin deze workflow.yaml.
  3. Commit en push het workflow-bestand naar jouw repository.

Lees meer over de configuratie-opties van de workflow.

Publiceren van Organisatie

Publiceren Frontend (Portaal)​

Om je eigen OpenCatalogi-portaal te publiceren, bieden we een GitHub-workflow aan. Voeg het workflow-bestand toe aan de .github-repository van de organisatie die je wilt publiceren. Publiceer vervolgens handmatig de gegenereerde GitHub Page.

  1. Maak binnen uw github organisaite een repositry aan met de naam .github (als us deze nog niet heeft)
  2. Maak binnen deze repository een map .github aan met daarin een map workflowsen plaats daarin deze workflow.yaml
  3. Ga binnen de repository naar instellingen(Settings) -> pagina's(Pages) en selecteer onder Build en deploy bij Branch gh-pages

Lees meer over de configuratie-opties van de workflow.

Publiceren van Frontend

Gebruiken als SAAS​

Als je vertrouwelijke data wilt beheren in OpenCatalogi, kun je de catalogus als SAAS afnemen. Voor alle deelnemersvan OpenCatalogi biedt Conduction een SAAS-installatie aan. Lees hier meer over deelname aan OpenCatalogi.

Als je niet wilt deelnemen aan de OpenCatalogi-coalitie maar wel gebruik wilt maken van de SAAS-oplossing, neem dan contact op met Conduction.

Lokaal Installeren​

Natuurlijk kun je als gebruiker van open-source software OpenCatalogi altijd lokaal installeren. Er zijn twee installatieroutes beschikbaar.

Kubernetes/Haven​

OpenCatalogi is een Common Ground-applicatie opgebouwd uit losse componenten. Deze componenten zijn ondergebracht in afzonderlijke Kubernetes-containers. Voor een volledige installatie zijn meerdere containers vereist.

Er zijn momenteel twee beproefde installatiemethoden. De primaire methode is via een Helm-installatie op Kubernetes. We bieden ook een voorgedefinieerde Helm-repository aan.

Haal de voorgedefinieerde repository op met:

helm repo add open-catalogi https://raw.githubusercontent.com/OpenCatalogi/web-app/development/helm/index.yaml

Installeer vervolgens met:

helm install [my-opencatalogi] open-catalogi/opencatalogi

Meer informatie over installatie via Helm vind je op de Helm-website. Meer details over de installatieopties zijn beschikbaar op Artifact Hub.

Linux​

De Linux-installatie-instructies volgen nog.