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.

Sign up for GitHub

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

Jump to bottom

update(docs): Indy configuration and ops sections #2507

Merged
merged 2 commits into from
Feb 15, 2024
Merged

update(docs): Indy configuration and ops sections #2507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa1c90b
update(docs): Indy configuration and ops sections
mgCepeda Feb 9, 2024
cc08f0b
Merge branch 'develop' into docs-2483
suvajit-sarkar Feb 15, 2024
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
346 changes: 7 additions & 339 deletions docs/source/guides/indy-add-new-org.md
View file
Open in desktop

Large diffs are not rendered by default.

208 changes: 71 additions & 137 deletions docs/source/guides/networkyaml-indy.md
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 8 additions & 7 deletions docs/source/guides/networkyaml-substrate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ env

The snapshot of the `env` section with example value is below
```yaml
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:18:29"
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:18:30"
```

The fields under `env` section are
Expand All @@ -60,6 +60,7 @@ The fields under `env` section are
|------------|---------------------------------------------|
| type | Environment type. Can be like dev/test/prod.|
| proxy | Choice of the Cluster Ingress controller. Currently supports 'ambassador' only as 'haproxy' has not been implemented for Substrate |
| proxy_namespace | Namespace in which the pods of the Cluster Ingress controller were deployed |
| ambassadorPorts | Any additional Ambassador ports can be given here. This is only valid if `proxy: ambassador`. These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports to be opened on Ambassador. Our sample uses a single cluster, so we have to open 4 ports for each Node. These ports are again specified in the `organization` section. |
| retry_count | Retry count for the checks. Use a high number if your cluster is slow. |
|external_dns | If the cluster has the external DNS service, this has to be set `enabled` so that the hosted zone is automatically updated. |
Expand All @@ -72,7 +73,7 @@ docker
The snapshot of the `docker` section with example values is below

```yaml
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:31:37"
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:32:38"
```

The fields under `docker` section are
Expand All @@ -90,7 +91,7 @@ config
The snapshot of the `config` section with example values is below

```yaml
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:39:54"
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:40:55"
```

The fields under `config` are
Expand All @@ -114,7 +115,7 @@ In the sample configuration example, we have four organization under the `organi

The snapshot of an organization field with sample values is below
```yaml
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:56:64"
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:57:65"
```

Each `organization` under the `organizations` section has the following fields.
Expand All @@ -135,7 +136,7 @@ Each `organization` under the `organizations` section has the following fields.
For the `aws`, `k8s` and `vault` field the snapshot with sample values is below

```yaml
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:65:79"
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:66:80"
```

The `aws` field under each organization contains: (This will be ignored if cloud_provider is not `aws`)
Expand Down Expand Up @@ -163,7 +164,7 @@ The `vault` field under each organization contains
For gitops fields the snapshot from the sample configuration file with the example values is below

```yaml
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:83:95"
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:84:96"
```

The gitops field under each organization contains
Expand All @@ -186,7 +187,7 @@ The services field for each organization under `organizations` section of Substr
Each organization will have a services section which includes details of all the peers, all participating nodes are names as peers. The snapshot of peers service with example values is below

```yaml
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:97:176"
--8<-- "platforms/substrate/configuration/samples/network-sample.yaml:98:177"
```

The fields under `peer` are
Expand Down
9 changes: 6 additions & 3 deletions platforms/hyperledger-indy/configuration/samples/network-indy-newnode-to-baf-network.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ network:
env:
type: indy # tag for the environment. Important to run multiple flux on single cluster
proxy: ambassador # value has to be 'ambassador' as 'haproxy' has not been implemented for Indy
ambassadorPorts:
proxy_namespace: "ambassador"
# These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports
# This sample uses a single cluster, so we have to open 3 ports for each Node. These ports are again specified for each organization below
ambassadorPorts: # Any additional Ambassador ports can be given here, this is valid only if proxy='ambassador'
portRange: # For a range of ports
from: 9711
to: 9720
from: 15010
to: 15052
loadBalancerSourceRanges: # (Optional) Default value is '0.0.0.0/0', this value can be changed to any other IP adres or list (comma-separated without spaces) of IP adresses, this is valid only if proxy='ambassador'
retry_count: 40 # Retry count for the checks
external_dns: enabled # Should be enabled if using external-dns for automatic route configuration
Expand Down
9 changes: 6 additions & 3 deletions ...forms/hyperledger-indy/configuration/samples/network-indy-newnode-to-non-baf-network.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@ network:
env:
type: indy # tag for the environment. Important to run multiple flux on single cluster
proxy: ambassador # value has to be 'ambassador' as 'haproxy' has not been implemented for Indy
ambassadorPorts:
proxy_namespace: "ambassador"
# These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports
# This sample uses a single cluster, so we have to open 3 ports for each Node. These ports are again specified for each organization below
ambassadorPorts: # Any additional Ambassador ports can be given here, this is valid only if proxy='ambassador'
portRange: # For a range of ports
from: 9711
to: 9712
from: 15010
to: 15052
loadBalancerSourceRanges: # (Optional) Default value is '0.0.0.0/0', this value can be changed to any other IP adres or list (comma-separated without spaces) of IP adresses, this is valid only if proxy='ambassador'
retry_count: 40 # Retry count for the checks
external_dns: enabled # Should be enabled if using external-dns for automatic route configuration
Expand Down
8 changes: 6 additions & 2 deletions platforms/hyperledger-indy/configuration/samples/network-indyv3-aries.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@ network:
env:
type: "bevel" # tag for the environment. Important to run multiple flux on single cluster
proxy: ambassador # value has to be 'ambassador' as 'haproxy' has not been implemented for Indy
# Must be different from all stward ambassador ports specified in the rest of this network yaml
proxy_namespace: "ambassador"
# These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports
# This sample uses a single cluster, so we have to open 3 ports for each Node. These ports are again specified for each organization below
ambassadorPorts: # Any additional Ambassador ports can be given here, this is valid only if proxy='ambassador'
ports: 15010,15023,15024,15025,15033,15034,15035,15043,15044,15045 # Each Client Agent uses 3 ports # Indy does not use a port range as it creates an NLB, and only necessary ports should be opened
portRange: # For a range of ports
from: 15010
to: 15052
loadBalancerSourceRanges: # (Optional) Default value is '0.0.0.0/0', this value can be changed to any other IP adres or list (comma-separated without spaces) of IP adresses, this is valid only if proxy='ambassador'
retry_count: 20 # Retry count for the checks
external_dns: enabled # Should be enabled if using external-dns for automatic route configuration
Expand Down
8 changes: 6 additions & 2 deletions platforms/hyperledger-indy/configuration/samples/network-indyv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,13 @@ network:
env:
type: "dev" # tag for the environment. Important to run multiple flux on single cluster
proxy: ambassador # value has to be 'ambassador' as 'haproxy' has not been implemented for Indy
# Must be different from all other ports specified in the rest of this network yaml
proxy_namespace: "ambassador"
# These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports
# This sample uses a single cluster, so we have to open 3 ports for each Node. These ports are again specified for each organization below
ambassadorPorts: # Any additional Ambassador ports can be given here, this is valid only if proxy='ambassador'
ports: 15010,15023,15024,15025,15033,15034,15035,15043,15044,15045 # Each Client Agent uses 3 ports # Indy does not use a port range as it creates an NLB, and only necessary ports should be opened
portRange: # For a range of ports
from: 15010
to: 15052
loadBalancerSourceRanges: # (Optional) Default value is '0.0.0.0/0', this value can be changed to any other IP adres or list (comma-separated without spaces) of IP adresses, this is valid only if proxy='ambassador'
retry_count: 20 # Retry count for the checks
external_dns: enabled # Should be enabled if using external-dns for automatic route configuration
Expand Down
1 change: 1 addition & 0 deletions platforms/substrate/configuration/samples/network-sample.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ network:
env:
type: "dscpdev" # tag for the environment. Important to run multiple flux on single cluster
proxy: ambassador # value has to be 'ambassador' as 'haproxy' has not been implemented for Substrate
proxy_namespace: "ambassador"
# These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports
# This sample uses a single cluster, so we have to open 4 ports for each Node. These ports are again specified for each organization below
ambassadorPorts: # Any additional Ambassador ports can be given here, this is valid only if proxy='ambassador'
Expand Down
1 change: 1 addition & 0 deletions platforms/substrate/configuration/samples/network-substrate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ network:
env:
type: "substratedev" # tag for the environment. Important to run multiple flux on single cluster
proxy: ambassador # value has to be 'ambassador' as 'haproxy' has not been implemented for Substrate
proxy_namespace: "ambassador"
# These ports are enabled per cluster, so if you have multiple clusters you do not need so many ports
# This sample uses a single cluster, so we have to open 4 ports for each Node. These ports are again specified for each organization below
ambassadorPorts: # Any additional Ambassador ports can be given here, this is valid only if proxy='ambassador'
Expand Down
Loading