Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial mkdocs content #121

Merged
merged 1 commit into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 0 additions & 106 deletions docs/KUBERNETES_CONFIG.md

This file was deleted.

117 changes: 0 additions & 117 deletions docs/TEST_NETWORK_K8S.md

This file was deleted.

84 changes: 0 additions & 84 deletions docs/TEST_NETWORK_NANO.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/about/community.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Community

You can find community discussion related to the Kubernetes Builder on the [#fabric-kubernetes](https://discord.com/channels/905194001349627914/945796983795384331) channel on Hyperledger Discord ([invite link](https://discord.gg/hyperledger)).
21 changes: 21 additions & 0 deletions docs/about/objectives.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Objectives

The aim is for the k8s builder to work as closely as possible with the existing [Fabric chaincode lifecycle](https://hyperledger-fabric.readthedocs.io/en/latest/chaincode_lifecycle.html), making sensible compromises for deploying chaincode on Kubernetes within those limitations.
(The assumption being that there are more people with Kubernetes skills than are familiar with the inner workings of Fabric!)

The two key principles are:

1. **The contents of the chaincode package must uniquely identify the chaincode functions executed on the ledger:**
In the case of the k8s builder the chaincode source code is not actually inside the package.
In order not to break the Fabric chaincode lifecycle, the chaincode image must be specified using an immutable `@digest`, not `:label` which can be altered post commit.
See [Pull an image by digest (immutable identifier)](https://docs.docker.com/engine/reference/commandline/pull/#pull-an-image-by-digest-immutable-identifier) for more details.

2. **The Fabric peer manages the chaincode process, not Kubernetes:**
Running the chaincode in server mode, i.e. allowing the peer to initiate the gRPC connection, would make it possible to leave Kubernetes to manage the chaincode process by creating a chaincode deployment.
Unfortunately due to limitations in Fabric's builder and launcher implementation, that is not possible and the peer expects to control the chaincode process.

## Status

The k8s builder is [close to a version 1 release](https://github.com/hyperledger-labs/fabric-builder-k8s/milestone/1) and has been tested in a number of Kubernetes environments, deployment platforms, and provides semantic-revision aware [release tags](https://github.com/hyperledger-labs/fabric-builder-k8s/tags) for the external builder binaries.

The current status should be considered as STABLE and any bugs or enhancements delivered as GitHub Issues in conjunction with community PRs.
Loading
Loading