Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,39 @@ Welcome to the SettleMint Blockchain Transformation Platform (BTP) guide. This g
## Overview
- [Introduction](#introduction)
- [Understand the installation process](#understand-the-installation-process)
- [Quick Start & Trial installations](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster/)
- [Quick Start & Sandbox installations](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster/)
- [Prerequisites](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure/)

- [Run the Installation](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/run-the-Installation/)
- [Get Support](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/support-and-troubleshooting/)
- [Get Support](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/support-and-troubleshooting/)

## Introduction

SettleMint BTP is built to ensure unmatched flexibility through its "Bring Your Own Infrastructure" strategy.
SettleMint BTP is built to ensure unmatched flexibility through its "Bring Your Own Infrastructure" strategy.

This strategy enables seamless integration of the blockchain transformation platform 'BTP' with your existing infrastructure, covering cloud services, databases, authentication providers, and storage solutions.
This strategy enables seamless integration of the blockchain transformation platform 'BTP' with your existing infrastructure, covering cloud services, databases, authentication providers, and storage solutions.

It also provides numerous benefits, such as enabling you to specify the high availability and readiness of each component, customize your disaster recovery plan, and implement the platform on familiar, white-labeled components, among others.

<!-- DIAGRAM HERE -->

After finishing the installation, you will have access to a suite of services and tools designed to support you throughout your blockchain journey. To explore these tools in detail, we invite you to visit our [Developer Hub](/docs/about-settlemint/intro/).
After finishing the installation, you will have access to a suite of services and tools designed to support you throughout your blockchain journey. To explore these tools in detail, we invite you to visit our [Developer Hub](/docs/about-settlemint/intro/).

- **Public chains**: Polygon PoS, Polygon zkevm, Ethereum, Avalanche, Arbitrum, Optimism, Binance Smart Chain *(Internet access required)*
- **Private chains**: Hyperledger Besu, Quorum, Hyperledger Fabric
- **Block Explorers**: Otterscan for Public networks, Blockscout for permissioned
- **Block Explorers**: Otterscan for Public networks, Blockscout for permissioned
- **Storage**: IPFS, MinIO
- **Integration Tools**: Integration studio, Hasura
- **Integration Tools**: Integration studio, Hasura
- **Integrated IDE**: Including smart contract sets
- **Smart contract Indexer**: The Graph Middleware
- **Smart contract Indexer**: The Graph Middleware

It's essential to remember that preparing your infrastructure and necessary services is a [prerequisite](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure/). Once this foundation is established, you'll need to populate the helm charts values file, as detailed in the subsequent "Platform installation” section.

## Understand the Installation Process

The installation procedure encompasses a series of crucial steps, including acquiring a licence, setting up your environment, launching the platform, and adjusting settings after installation.
The installation procedure encompasses a series of crucial steps, including acquiring a licence, setting up your environment, launching the platform, and adjusting settings after installation.

### The Installation Process:
### The Installation Process:
1. **Obtain a License:** Contact SettleMint at hello@settlemint.com to obtain a licence key.
2. **Registry Authentication:** Authenticate with our container registry using the credentials provided via email.
3. **Prepare Your Environment:** Set up your Kubernetes cluster, configure the domain, TLS, storage, and authentication provider (see prerequisites).
Expand All @@ -54,8 +54,8 @@ The installation procedure encompasses a series of crucial steps, including acqu
Should you encounter any issues or have questions during any phase of the installation process, feel free to contact us at support@settlemint.com. Our team is ready to assist you.


Next:
- [Explore one of our trial installations](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster/) to get a hands-on feel for the platform
Next:
- [Explore one of our sandbox installations](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster/) to get a hands-on feel for the platform
- [Proceed to the prerequisites page](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure/) to prepare for a full installation


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ You have the option to deploy services in separate namespaces for each service o
### 4. Setting Up Domain Names for Service Access

Access to services is facilitated through domain names. The setup can involve:

- Wildcard DNS

entries for each cluster, ensuring they include TLS termination to secure the domain.
Expand All @@ -266,8 +266,8 @@ targets:
name: "Google Cloud"
icon: google
clusters:
- id: trial
name: "Trial Demo"
- id: sandbox
name: "Sandbox Demo"
icon: belgium
location:
lat: 50.8505
Expand All @@ -281,7 +281,7 @@ targets:
domains:
service:
tls: true
hostname: "trial-saeed.blockchaintransformationplatform.com"
hostname: "sandbox-saeed.blockchaintransformationplatform.com"
storage:
storageClass: "standard-rwo"
ingress:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Quick Start Examples & Trial Installations ",
"label": "Quick Start Examples & Sandbox Installations ",
"position": 3
}
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
sidebar_position: 1
sidebar_label: 'Trial Installation: All Prerequisites in the Cluster'
sidebar_label: 'Sandbox Installation: All Prerequisites in the Cluster'
---
# SettleMint Platform Trial Installation Guide (all prerequisites installed in the cluster)
# SettleMint Platform Sandbox Installation Guide (all prerequisites installed in the cluster)

This trial installation guide provides the steps for setting up and installing the SettleMint Blockchain Transformation Platform on a managed Kubernetes cluster. The guide assumes a prior understanding of Kubernetes, Helm, Google Kubernetes Engine (GKE), and other relevant technologies.
This sandbox installation guide provides the steps for setting up and installing the SettleMint Blockchain Transformation Platform on a managed Kubernetes cluster. The guide assumes a prior understanding of Kubernetes, Helm, Google Kubernetes Engine (GKE), and other relevant technologies.

**NOTE:** Trial installations are not designed or suitable for production use and cannot be upgraded to a production-ready state. Use this trial setup at your own risk.
**NOTE:** Sandbox installations are not designed or suitable for production use and cannot be upgraded to a production-ready state. Use this sandbox setup at your own risk.

## Contents

- [SettleMint Platform Trial Installation Guide (all prerequisites installed in the cluster)](#settlemint-platform-trial-installation-guide-all-prerequisites-installed-in-the-cluster)
- [SettleMint Platform Sandbox Installation Guide (all prerequisites installed in the cluster)](#settlemint-platform-trial-installation-guide-all-prerequisites-installed-in-the-cluster)
- [Contents](#contents)
- [Requirements](#requirements)
- [Managed Kubernetes Cluster Setup](#managed-kubernetes-cluster-setup)
Expand Down Expand Up @@ -133,13 +133,13 @@ kubectl get service --namespace ingress-nginx ingress-nginx-controller --output
Then, you need to link a domain name to the external load balancer IP. Create an A record in your DNS provider that points to this IP and ensure that it resolves:

```bash
dig trial-demo.blockchaintransformationplatform.com
dig sandbox-demo.blockchaintransformationplatform.com
```

You will also need to create a wildcard CNAME `*.trial-demo.blockchaintransformationplatform.com` that points to `trial-demo.blockchaintransformationplatform.com` and confirm that it resolves:
You will also need to create a wildcard CNAME `*.sandbox-demo.blockchaintransformationplatform.com` that points to `sandbox-demo.blockchaintransformationplatform.com` and confirm that it resolves:

```bash
dig random.trial-demo.blockchaintransformationplatform.com
dig random.sandbox-demo.blockchaintransformationplatform.com
```

### [TLS Configuration](#tls-configuration)
Expand All @@ -156,7 +156,7 @@ helm upgrade --install \
--set installCRDs=true
```

To issue wildcard certificates, you MUST use the dns01 solver. Suppose this domain uses Cloudflare as the DNS provider. In this case, configure the dns01 resolver with Cloudflare. Start by making an API token for the zone on [https://dash.cloudflare.com/profile/api-tokens](https://dash.cloudflare.com/profile/api-tokens) and store it in this secret:
To issue wildcard certificates, you MUST use the dns01 solver. Suppose this domain uses Cloudflare as the DNS provider. In this case, configure the dns01 resolver with Cloudflare. Start by making an API token for the zone on [https://dash.cloudflare.com/profile/api-tokens](https://dash.cloudflare.com/profile/api-tokens) and store it in this secret:

```bash
kubectl apply -n cert-manager -f - <<EOF
Expand All @@ -182,7 +182,7 @@ metadata:
namespace: cert-manager
spec:
acme:
email: trial-demo@settlemint.com
email: sandbox-demo@settlemint.com
server: https://acme-v02.api.letsencrypt.org/directory
privateKeySecretRef:
name: issuer-account-key
Expand Down Expand Up @@ -453,7 +453,7 @@ and make/use one with WaitForFirstConsumer and with volume expansion set to true

In this example we will use Google login. [Browse to https://console.developers.google.com/apis/credentials]( https://console.developers.google.com/apis/credentials])and on the top use `+ CREATE CREDENTIALS`, choose `OAuth client ID` and then as type `Web application`.

In `Authorised JavaScript origins` add the domain name you created in the Ingress controller section, in this example `https://trial-demo.blockchaintransformationplatform.com`. In `Authorised redirect URIs` use `https://trial-demo.blockchaintransformationplatform.com/api/auth/callback/google`.
In `Authorised JavaScript origins` add the domain name you created in the Ingress controller section, in this example `https://sandbox-demo.blockchaintransformationplatform.com`. In `Authorised redirect URIs` use `https://sandbox-demo.blockchaintransformationplatform.com/api/auth/callback/google`.

You will get a Client ID and Client secret at the end of this process, note them down for later.

Expand Down Expand Up @@ -491,8 +491,8 @@ ingress:
tls:
- secretName: "blockchaintransformationplatform"
hosts:
- "trial-demo.blockchaintransformationplatform.com"
- "*.trial-demo.blockchaintransformationplatform.com"
- "sandbox-demo.blockchaintransformationplatform.com"
- "*.sandbox-demo.blockchaintransformationplatform.com"
redis:
host: redis-master.redis.svc.cluster.local
password: supersecretredispassword
Expand Down Expand Up @@ -523,10 +523,10 @@ features:
deploymentEngine:
platform:
domain:
hostname: "trial-demo.blockchaintransformationplatform.com"
hostname: "sandbox-demo.blockchaintransformationplatform.com"
clusterManager:
domain:
hostname: "trial-demo.blockchaintransformationplatform.com"
hostname: "sandbox-demo.blockchaintransformationplatform.com"
state:
s3ConnectionUrl: "s3://myminiobucket?region=eu-central-1&endpoint=minio.minio.svc.cluster.local:9000&disableSSL=true&s3ForcePathStyle=true"
credentials:
Expand All @@ -540,8 +540,8 @@ features:
name: "Google Cloud"
icon: google
clusters:
- id: trial
name: "Trial Demo"
- id: sandbox
name: "Sandbox Demo"
icon: belgium
location:
lat: 50.8505
Expand All @@ -555,7 +555,7 @@ features:
domains:
service:
tls: true
hostname: "trial-demo.blockchaintransformationplatform.com"
hostname: "sandbox-demo.blockchaintransformationplatform.com"
storage:
storageClass: "standard-rwo"
ingress:
Expand Down Expand Up @@ -587,7 +587,7 @@ docs:
EOF
```

<!-- You should now be able to access the platform at <https://trial-demo.blockchaintransformationplatform.com>. -->
<!-- You should now be able to access the platform at <https://sandbox-demo.blockchaintransformationplatform.com>. -->

**IMPORTANT:** Please refer to the actual SettleMint documentation for the most up-to-date, detailed, and accurate instructions. This is an illustrative guide and may be outdated or incorrect, and there may be additional configuration steps required for a fully functional deployment.

Expand Down Expand Up @@ -623,4 +623,4 @@ You can then send the generated file to [support@settlemint.com](mailto:support@

Enjoy exploring the SettleMint Platform!

**NOTE:** This trial installation of the SettleMint platform might not include the full functionalities of the platform. To explore a full-scale, premium tier of the SettleMint Platform, consider reaching out to the SettleMint team for a premium trial or subscription.
**NOTE:** This sandbox installation of the SettleMint platform might not include the full functionalities of the platform. To explore a full-scale, premium tier of the SettleMint Platform, consider reaching out to the SettleMint team for a premium sandbox or subscription.
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
sidebar_position: 2
sidebar_label: 'Trial Installation: Embedded Prerequisites Integration'
sidebar_label: 'Sandbox Installation: Embedded Prerequisites Integration'
---
# SettleMint Platform Trial Installation Guide (embedded)
# SettleMint Platform Sandbox Installation Guide (embedded)

This trial installation guide provides the steps for setting up and installing the SettleMint Blockchain Transformation Platform
This sandbox installation guide provides the steps for setting up and installing the SettleMint Blockchain Transformation Platform
on a managed Kubernetes cluster. The guide assumes a prior understanding of Kubernetes, CIVO Cloud,
and other relevant technologies.

**NOTE:** Trial installations are not designed or suitable for production use and cannot be upgraded to a production-ready state. Use this trial setup at your own risk.
**NOTE:** Sandbox installations are not designed or suitable for production use and cannot be upgraded to a production-ready state. Use this sandbox setup at your own risk.

## [Requirements](#requirements)

Expand All @@ -26,13 +26,13 @@ This section covers the installation prerequisites, including setting up a domai
You need to link a domain name to the external load balancer IP. Create an A record in your DNS provider that points to this IP and ensure that it resolves:

```bash
dig trial-demo.blockchaintransformationplatform.com
dig sandbox-demo.blockchaintransformationplatform.com
```

You will also need to create a wildcard CNAME `*.trial-demo.blockchaintransformationplatform.com` that points to `trial-demo.blockchaintransformationplatform.com` and confirm that it resolves:
You will also need to create a wildcard CNAME `*.sandbox-demo.blockchaintransformationplatform.com` that points to `sandbox-demo.blockchaintransformationplatform.com` and confirm that it resolves:

```bash
dig random.trial-demo.blockchaintransformationplatform.com
dig random.sandbox-demo.blockchaintransformationplatform.com
```

### [TLS Configuration](#tls-configuration)
Expand Down Expand Up @@ -61,7 +61,7 @@ For the Postgresql database we will be using the Serverless Postgres offering fr
Create a new database and note the connections details (with pooling enabled) as we will need them later, it will look something like

```
postgresql://trial-demo_owner:************@ep-morning-moon-a20p0s24-pooler.eu-central-1.aws.neon.tech/trial-demo?sslmode=require
postgresql://sandbox-demo_owner:************@ep-morning-moon-a20p0s24-pooler.eu-central-1.aws.neon.tech/sandbox-demo?sslmode=require
```

### [S3 Storage Setup](#s3-setup)
Expand Down Expand Up @@ -129,7 +129,7 @@ Record the role id and secret id as they will be needed later.

In this example we will use Google login. Browse to https://console.developers.google.com/apis/credentials and on the top use `+ CREATE CREDENTIALS`, choose `OAuth client ID` and then as type `Web application`.

In `Authorised JavaScript origins` add the domain name you created in the Ingress controller section, in this example `https://trial-demo.blockchaintransformationplatform.com`. In `Authorised redirect URIs` use `https://trial-demo.blockchaintransformationplatform.com/api/auth/callback/google`.
In `Authorised JavaScript origins` add the domain name you created in the Ingress controller section, in this example `https://sandbox-demo.blockchaintransformationplatform.com`. In `Authorised redirect URIs` use `https://sandbox-demo.blockchaintransformationplatform.com/api/auth/callback/google`.

You will get a Client ID and Client secret at the end of this process, note them down for later.

Expand Down Expand Up @@ -166,7 +166,7 @@ allowVolumeExpansion: true
EOF
```

How to handle
How to handle

Answer the questions and wait for it to install the KOTS admin panel.

Expand All @@ -187,7 +187,7 @@ From your CS contact you will have received a license file, upload it in the nex

Then we will need to configure the platform using the values we collected above and then press continue.

You should now be able to access the platform at https://trial-demo.blockchaintransformationplatform.com.
You should now be able to access the platform at https://sandbox-demo.blockchaintransformationplatform.com.

**IMPORTANT:** Please refer to the actual SettleMint documentation for the most up-to-date, detailed, and accurate instructions. This is an illustrative guide and may be outdated or incorrect, and there may be additional configuration steps required for a fully functional deployment.

Expand Down Expand Up @@ -223,4 +223,4 @@ You can then send the generated file to [support@settlemint.com](mailto:support@

Enjoy exploring the SettleMint Platform!

**NOTE:** This trial installation of the SettleMint platform might not include the full functionalities of the platform. To explore a full-scale, premium tier of the SettleMint Platform, consider reaching out to the SettleMint team for a premium trial or subscription.
**NOTE:** This sandbox installation of the SettleMint platform might not include the full functionalities of the platform. To explore a full-scale, premium tier of the SettleMint Platform, consider reaching out to the SettleMint team for a premium sandbox or subscription.
Loading