search

hyperledger / cacti

Hyperledger Cacti is a new approach to the blockchain interoperability problem
https://wiki.hyperledger.org/display/cactus
Apache License 2.0
323 stars 276 forks source link

docs(examples): carbon accounting microk8s deployment files #860

Open petermetz opened 3 years ago

petermetz commented 3 years ago

Description

As a contributor/maintainer I want to be able to have an easy way of deploying the carbon accounting example to a microk8s Kubernetes cluster so that I can see a good example of how projects using Cactus can be operated in a data center environment.

We start with microk8s because that's the default Ubuntu k8s distro and our CI pipeline is built on top of Ubuntu already so this should eliminate a few extra complexities compared to focusing on other k8s distros instead since microk8s could be tested on a Windows computer as well via WSL 2

While working on this issue it is likely that other shortcomings will be unearthed in the code-base, things that could warrant their own user stories/bugs as well and therefore the classification of this issue is "400-expert" because there's no major change in the code, but you'll need to be an expert in a few different things to progress with this.

Acceptance Criteria

  1. There's either a Helm chart defined or a KNative file defined and a top level npm script that performs the deployment to a microk8s Kubernetes cluster
  2. The process of performing the deployment/testing it out is documented to the extent that it should be workable from the point where someone has an Ubuntu machine fresh out of the oven so to speak. For setting up the k8s cluster itself it's sufficient to reference the documentation of microk8s itself, but the specific addons we need have to be documented of course.

cc: @takeutak @sfuji822 @hartm @jonathan-m-hamilton @AzaharaC @jordigiam @kikoncuo @jagpreetsinghsasan @arnab-roy

sfuji822 commented 3 years ago

Can you clarify what is the appeal point of this example? I prefer to have examples as the showcase of different usages of Cactus for education purposes. Since I also think it has real value, it should be hosted as an independent registry. What do you think? @petermetz

petermetz commented 3 years ago

@sfuji822 The appeal (to me): deploying the software is using the software, so people will want to know what's the recommended way of doing it. Kubernetes is widely used so I figured it's a good starting point for ops people. Independent registry: I don't have the bandwidth to deal with the overhead of managing it, but if you could take that part on, then, fine by me for sure!