Skip to content
This repository has been archived by the owner on Dec 10, 2024. It is now read-only.

The Cardano Explorer makes it easy for regulators, policymakers and regulated entities to navigate the Cardano blockchain without having to be Cardano experts. Publicly available and to be open sourced soon!

License

Notifications You must be signed in to change notification settings

cardano-foundation/cf-explorer

Cardano Foundation Explorer Deployment

This project contains manifests and scripts to bootstrap and deploy the Cardano Foundation Explorer project and all its dependencies.

flowchart LR
    A[Explorer Frontend] --> B[Explorer API]
    A --> C[Explorer Authentication\n Service]
    C --> D[Keycloak]
    B --> E[(Postgres Database)]
    F[Explorer Rewards Service] --> E
    G[Koios] --> F
    H[Explorer Scheduled\n Services] --> E
    E --> H
    I[LedgerSync] --> E 
    cp{{Explorer Common\nPackage}}

    style A fill:#5C8DFF,stroke:#5C8DFF
    style B fill:#5C8DFF,stroke:#5C8DFF
    style C fill:#5C8DFF,stroke:#5C8DFF
    style D fill:#1EC198,stroke:#1EC198
    style E fill:#1EC198,stroke:#1EC198

    style F fill:#5C8DFF,stroke:#5C8DFF
    style G fill:#1EC198,stroke:#1EC198
    style H fill:#5C8DFF,stroke:#5C8DFF
    style I fill:#1EC198,stroke:#1EC198
    style cp fill:#F6C667,stroke:#F6C667
Loading

Tested Configuration

Repository Version
cf-ledger-consumer-schedules 0.2.19
cf-explorer-api 0.5.0
cf-explorer-rewards-api 0.1.7
cf-explorer-authentication 0.1.15
cf-explorer-frontend 0.5.3

Note

Please ensure that you run these services alongside the latest version of LedgerSync ⛓.

Continuous Deployment

ArgoCD ís the Continuous Deployment system of choice for deploying the applications that compose the Explorer system and all its dependencies.

Bootstrap

Bootstrapping a cluster is the process of deploying artifacts for the very first time. ArgoCD itself needs to be deployed the first time and then, in turn ArgoCD will deploy all the components under its control in a GitOps fashion.

An Application In ArgoCD is a:

A group of Kubernetes resources as defined by a manifest. This is a Custom Resource Definition (CRD).

Some examples could be:

  1. Microservices and all their resources (workers, network resources, DNS definitions, scaling policies)
  2. Databases
  3. System / Administration services (metric server etc)

In order to bootstrap the cluster is used the technique of App of Apps.

For more info, check the README.md

Helm Repositories

Full list of helm repositories to add

helm repo add argo-cd https://argoproj.github.io/argo-helm
helm repo add sealed-secrets https://bitnami-labs.github.io/sealed-secrets
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add traefik https://helm.traefik.io/traefik
helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo add elastic https://helm.elastic.co

Embedded Services

Kibana

Kibana credentials are:

  • user: elastic
  • password: kubectl get secret -n elastic-stack quickstart-es-elastic-user -o json | jq -r .data.elastic

About

The Cardano Explorer makes it easy for regulators, policymakers and regulated entities to navigate the Cardano blockchain without having to be Cardano experts. Publicly available and to be open sourced soon!

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Languages