Added Version list

Signed-off-by: sownak <git@email.com>
hyperledger-bevel · Dec 13, 2023 · 636e8dd · 636e8dd
1 parent f994b9f
commit 636e8dd
Show file tree

Hide file tree

Showing 15 changed files with 206 additions and 381 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -51,6 +51,9 @@ markdown_extensions:
       smart_enable: all
   - pymdownx.caret
   - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.inlinehilite
@@ -146,12 +149,12 @@ nav:
     - Other Operations:
       - guides/indy-add-new-org.md
       - guides/quorum-add-new-org.md
-      - guides/bevel-debug.md
   - References:
     - Commands: references/commands.md
+    - Troubleshooting: references/troubleshooting.md
     - Roadmap: references/roadmap.md
+    - Tool Versions: references/tool-versions.md
     - Architecture: references/architecture.md
-    - Tool Versions: references/compatibilitytable.md
   - Samples:
     - Supplychain App: samples/supplychain.md
     - Identity App: samples/indy-refapp.md

diff --git a/docs/source/faqs.md b/docs/source/faqs.md
@@ -66,7 +66,7 @@ Hyperledger Bevel relies a lot on using [Ansible](./concepts/ansible.md), which
 Please follow our [Getting Started guide](./getting-started/run-bevel.md).
 
 ### How can I test whether my DLT/Blockchain network are configured and deployed correctly?
-Please check the [debug guide](./guides/bevel-debug.md) for details.
+Please check the [troubleshooting guide](./references/troubleshooting.md) for details.
 
 ### How/Where can I request for new features, bugs and get feedback?
 Please follow our [contributing guidelines](./contributing/how-to-contribute.md) for this.
@@ -84,11 +84,6 @@ Yes, you can find an example ansible_hosts file [here](https://github.com/hyperl
 Yes, you can specify tools versions like kubectl, helm, HashiCorp Vault, AWS-Authenticator in the playbook [setup-environment.yaml](https://github.com/hyperledger/bevel/tree/main/platforms/shared/configuration/setup-environment.yaml).
 
 ### How would system react if we plan to update tools versions (e.g. kubectl, helm)?
-The latest version Hyperledger Bevel has been tested on specific client versions of these tools, see below:
-(1) Kubectl: v1.23.8 for Kubernetes v1.23+ (tested upto v1.24)
-(2) Helm: v3.6.2
-(3) HashiCorp Vault: v1.13.1
-(4) AWS-Authenticator: v1.10.3
-(5) Ansible 5.9.0, Ansible [core 2.12.6]
-
-It is assumed that newer versions of these tools would be backward compatible, which is beyond our control. You can raise a new ticket to Hyperledger Bevel GitHub repository, if any major updates would break the system down.
+The latest version Hyperledger Bevel has been tested on specific client versions of the tools. see [versions supported](./references/tool-versions.md) for latest.
+
+It is assumed that newer versions of these tools would be backward compatible. You can raise a new ticket to Hyperledger Bevel GitHub repository, if any major updates would break the system.
diff --git a/docs/source/getting-started/run-bevel.md b/docs/source/getting-started/run-bevel.md
@@ -50,4 +50,4 @@ ansible-playbook  platforms/shared/configuration/site.yaml -e "@/path/to/network
 
 For more detailed instructions to set up a network, check [Setting up a DLT/Blockchain network Tutorial](../tutorials/machine-deploy.md).
 
-For instructions on how to verify or troubleshoot network, read [How to debug a Bevel deployment](../guides/bevel-debug.md)
+For instructions on how to troubleshoot network, read [our troubleshooting guide](../references/troubleshooting.md)
diff --git a/docs/source/guides/besu/add-new-member-org.md b/docs/source/guides/besu/add-new-member-org.md
@@ -184,4 +184,4 @@ ansible-playbook platforms/shared/configuration/add-new-organization.yaml --extr
 ```
 
 ## Verify network deployment
-For instructions on how to verify or troubleshoot network, read [How to debug a Bevel deployment](../bevel-debug.md)
+For instructions on how to troubleshoot network, read [our troubleshooting guide](../../references/troubleshooting.md)
diff --git a/docs/source/guides/bevel-debug.md b/docs/source/guides/bevel-debug.md
diff --git a/docs/source/guides/fabric/upgrade-network.md b/docs/source/guides/fabric/upgrade-network.md
@@ -52,4 +52,4 @@ The playbook [site.yaml](https://github.com/hyperledger/bevel/tree/main/platform
 ansible-playbook platforms/shared/configuration/site.yaml --extra-vars "@path-to-network.yaml"
 ```
 ## Verify network deployment
-For instructions on how to verify or troubleshoot network, read [How to debug a Bevel deployment](../bevel-debug.md)
+For instructions on how to troubleshoot network, read [our troubleshooting guide](../../references/troubleshooting.md)
diff --git a/docs/source/guides/quorum-add-new-org.md b/docs/source/guides/quorum-add-new-org.md
@@ -183,4 +183,4 @@ ansible-playbook platforms/shared/configuration/site.yaml --extra-vars "@path-to
 ```
 
 ## Verify network deployment
-For instructions on how to verify or troubleshoot network, read [How to debug a Bevel deployment](./bevel-debug.md)
+For instructions on how to troubleshoot network, read [our troubleshooting guide](../references/troubleshooting.md)
diff --git a/docs/source/references/commands.md b/docs/source/references/commands.md
@@ -29,6 +29,10 @@ Below are some commands that can be used for debugging.
     ```
     kubectl get pods --all-namespaces
     ```
+* To watch new pods creation in the cluster
+    ```
+    kubectl get pods --all-namespaces --watch
+    ```
 * To check description of resource type (pod/service/pvc/HelmRelease)
     ```bash
     kubectl describe RESOURCE_TYPE RESOURCE_NAME -n NAMESPACE
@@ -45,6 +49,16 @@ Below are some commands that can be used for debugging.
     kubectl logs POD_NAME -c CONTAINER_NAME -n NAMESPACE
     # e.g. kubectl logs ca-123r45 -c ca-certs-init -n carrier-net
     ```
+* To get all the helmreleases in a namespace
+    ```bash
+    kubectl get hr -n NAMESPACE
+    # e.g. kubectl get hr -n carrier-net
+    ```
+* To delete a helmrelease so as to restart it in a namespace
+    ```bash
+    kubectl delete hr HELMRELEASENAME -n NAMESPACE
+    # e.g. kubectl delete hr channel-carrier-allchannel -n carrier-net
+    ```
 * To execute a command in a running pod
     ```bash
     kubectl exec POD_NAME -n NAMESPACE -- COMMAND_TO_EXECUTE

diff --git a/docs/source/references/compatibilitytable.md b/docs/source/references/compatibilitytable.md
diff --git a/docs/source/references/roadmap.md b/docs/source/references/roadmap.md
@@ -40,16 +40,16 @@ Legend of annotations:
 | :octicons-trophy-16:            | stretch goal     |
 | :octicons-stop-16:                  | on hold          |
 
-Documentation
--------------
+## Documentation
+
 -  :material-run: Complete restructure and redesign of documentation
 -  :material-run: Spell and grammar linting
 -  :material-run: Update troubleshooting guide
 -  :material-run: Replace ansible roles readme with high level information
 -  :octicons-check-16: Add helm chart readme for platform charts
 
-General/Shared
---------------
+## General/Shared
+
 - :octicons-trophy-16:  Improve logging/error messaging in playbooks and log storage
 - :material-run: Adding proper log message on the helm charts
 - :octicons-stop-16:   Setup AWS cloudwatch exporter
@@ -65,8 +65,8 @@ General/Shared
 - :octicons-check-16: Creation of vault auth role from the vault-k8s chart
 - :octicons-check-16: Add default values to chart templates/values section
 
-Platforms
----------
+## Platforms
+
 - R3 Corda Enterprise and open source
     - :octicons-stop-16:   HA Notary options
     - :octicons-stop-16:   Enable PostGreSQL support for Corda Enterprise
@@ -99,14 +99,14 @@ Platforms
     - :octicons-trophy-16:  Test with generic substrate node
     - :octicons-trophy-16:  Adding of org/new node
 
-Bevel Samples
--------------
+## Bevel Samples
+
 -  :octicons-pin-16: Upgrade Ambassador proxy to Edge stack
 -  :octicons-pin-16: Upgrade rest server/middleware applications
 -  :octicons-pin-16: Upgrade aca py application
 
-Bevel Kubernetes Operators
---------------------------
+## Bevel Kubernetes Operators
+
 - Bevel-Operator-Fabric
     - :octicons-pin-16: Host helm charts to github hosted helm repo
     - :octicons-trophy-16:  Use bevel platforms fabric chart
@@ -117,6 +117,6 @@ Bevel Kubernetes Operators
 - Operator Corda
     - :octicons-stop-16:   Architecture diagram
 
-DevOps-Pipeline
----------------
+## DevOps-Pipeline
+
 - :octicons-pin-16: GitHub Actions automation script for each DLT platform
diff --git a/docs/source/references/tool-versions.md b/docs/source/references/tool-versions.md
@@ -0,0 +1,32 @@
+[//]: # (##############################################################################################)
+[//]: # (Copyright Accenture. All Rights Reserved.)
+[//]: # (SPDX-License-Identifier: Apache-2.0)
+[//]: # (##############################################################################################)
+# Tool Versions
+The latest version of Hyperledger Bevel works with the following tool versions.
+
+| Tools | Version |
+|--|--|
+| Ambassador | 3.7.2 |
+| Ambassador edge-stack Chart | 8.7.2 |
+| Ansible | core 2.12.6 |
+| Flux | 0.35.0 |
+| HAProxy Ingress (for Fabric only) | 0.13.9 |
+| Hashicorp Vault | 1.14.2 |
+| Helm | v3.6.2 |
+| Kubernetes/kubectl | 1.24 |
+
+## Platform Versions
+The latest version of Hyperledger Bevel supports the following DLT Platforms.
+
+| DLT Platform | Version |
+|--|--|
+| Corda Open-source Node | 4.9 |
+| Corda Enterprise Node | 4.7 |
+| Corda Enterprise Network Manager | 1.5 |
+| Corda Enterprise Firewall | Float DMZ |
+| Fabric | 1.4.x, 2.2.x, 2.5.x |
+| GoQuorum | 23.4.0 |
+| Indy | 1.12 |
+| Besu | 22.10.2 |
+| Tessera | 21.7.3, 23.4.0 |
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,4 +50,4 @@ ansible-playbook platforms/shared/configuration/site.yaml -e "@/path/to/network

		For more detailed instructions to set up a network, check [Setting up a DLT/Blockchain network Tutorial](../tutorials/machine-deploy.md).

		For instructions on how to verify or troubleshoot network, read [How to debug a Bevel deployment](../guides/bevel-debug.md)
		For instructions on how to troubleshoot network, read [our troubleshooting guide](../references/troubleshooting.md)