Skip to content

Commit cd3eb54

Browse files
feat: Adding the new BTP docs (#5)
added the content of this file to the doc https://docs.google.com/document/d/1su3-38HWsPBEV7quiDEY4MBHdEWKvyzwEKTNIqTRkWE/edit created a "legacy" folder in the docs with the old installation docs <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Updated labels for better clarity in the platform documentation. - Added new files introducing installation guides and prerequisites for the SettleMint Blockchain Transformation Platform (BTP). - Provided comprehensive guides for trial installations on managed Kubernetes clusters. - Included instructions for running the installation using a Helm chart. - Added support and troubleshooting documentation for platform installation. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: saeeddawod <saeed.dawod@gmail.com>
1 parent 350275d commit cd3eb54

32 files changed

+16696
-6
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "On-premise Deployment",
2+
"label": "Self Hosted Deployment",
33
"position": 2
44
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Installation",
2+
"label": "Installation Guide",
33
"position": 3
44
}
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: Introduction
4+
---
5+
6+
# SettleMint BTP - Installation Guide
7+
8+
Welcome to the SettleMint Blockchain Transformation Platform (BTP) guide. This guide is designed to walk you through the core principles of our platform, outline what you'll need to get started, and guide you through the installation process.
9+
10+
## Overview
11+
- [Introduction](#introduction)
12+
- [Understand the installation process](#understand-the-installation-process)
13+
- [Quick Start & Trial installations](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/quick-start-examples-trial-installation/installation-trial-cluster/)
14+
- [Prerequisites](/docs/launch-platform/self-hosted/installing-on-an-existing-cluster/prerequisites/Infrastructure/)
15+
- [Run the Installation](#)
16+
- [Get Support](#)
17+
18+
## Introduction
19+
20+
SettleMint BTP is built to ensure unmatched flexibility through its "Bring Your Own Infrastructure" strategy.
21+
22+
This strategy enables seamless integration of the blockchain transformation platform 'BTP' with your existing infrastructure, covering cloud services, databases, authentication providers, and storage solutions.
23+
24+
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.
25+
26+
<!-- DIAGRAM HERE -->
27+
28+
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](#).
29+
30+
- **Public chains**: Polygon PoS, Polygon zkevm, Ethereum, Avalanche, Arbitrum, Optimism, Binance Smart Chain *(Internet access required)*
31+
- **Private chains**: Hyperledger Besu, Quorum, Hyperledger Fabric
32+
- **Block Explorers**: Otterscan for Public networks, Blockscout for permissioned
33+
- **Storage**: IPFS, MinIO
34+
- **Integration Tools**: Integration studio, Hasura
35+
- **Integrated IDE**: Including smart contract sets
36+
- **Smart contract Indexer**: The Graph Middleware
37+
38+
It's essential to remember that preparing your infrastructure and necessary services is a [prerequisite](link). Once this foundation is established, you'll need to populate the helm charts values file, as detailed in the subsequent "Platform installation” section.
39+
40+
## Understand the Installation Process
41+
42+
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.
43+
44+
### The Installation Process:
45+
1. **Obtain a License:** Contact SettleMint at hello@settlemint.com to obtain a licence key.
46+
2. **Registry Authentication:** Authenticate with our container registry using the credentials provided via email.
47+
3. **Prepare Your Environment:** Set up your Kubernetes cluster, configure the domain, TLS, storage, and authentication provider (see prerequisites).
48+
4. **Service Preparation:** Deploy and configure the required services (Redis, Postgres, Vault) as per your HA and configurability needs.
49+
5. **Deploy the Platform:** Use Helm to add the SettleMint repository, update it, and install BTP v7 with your custom configurations.
50+
6. **Enjoy the Platform 🥳:** Access and explore the functionalities of SettleMint BTP.
51+
52+
53+
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.
54+
55+
56+
Next:
57+
- [Explore one of our trial installations](#) to get a hands-on feel for the platform
58+
- [Proceed to the prerequisites page](#) to prepare for a full installation
59+
60+
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Legacy",
3+
"position": 8
4+
}

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/auth-api-requests.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/auth-api-requests.md

File renamed without changes.

docs/launch-platform/self-hosted/installing-on-an-existing-cluster/completing-setup-and-deploying.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/completing-setup-and-deploying.md

File renamed without changes.

docs/launch-platform/self-hosted/download/_category_.json renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Download",
3-
"position": 2
3+
"position": 10
44
}

docs/launch-platform/self-hosted/download/download-airgap.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-airgap.md

File renamed without changes.

docs/launch-platform/self-hosted/download/download-online.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-online.md

File renamed without changes.

docs/launch-platform/self-hosted/download/download-portal.md renamed to docs/launch-platform/self-hosted/installing-on-an-existing-cluster/legcay/download/download-portal.md

File renamed without changes.

0 commit comments

Comments
 (0)