Skip to content

Commit

Permalink
AUTO: Sync Kubernetes docs to ScalarDL docs site repo
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-wong committed Sep 9, 2024
1 parent 6e02d32 commit d714274
Show file tree
Hide file tree
Showing 41 changed files with 214 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Make ScalarDB or ScalarDL deployed in a Kubernetes cluster environment available from applications

This document explains how to make ScalarDB or ScalarDL deployed in a Kubernetes cluster environment available from applications. To make ScalarDB or ScalarDL available from applications, you can use Scalar Envoy via a Kubernetes service resource named `<HELM_RELEASE_NAME>-envoy`. You can use `<HELM_RELEASE_NAME>-envoy` in several ways, such as:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# How to install Scalar products through AWS Marketplace

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# How to install Scalar products through Azure Marketplace

import Tabs from '@theme/Tabs';
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-3.8/scalar-kubernetes/BackupNoSQL.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Back up a NoSQL database in a Kubernetes environment

This guide explains how to create a transactionally consistent backup of managed databases that ScalarDB or ScalarDL uses in a Kubernetes environment. Please note that, when using a NoSQL database or multiple databases, you **must** pause ScalarDB or ScalarDL to create a transactionally consistent backup.
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-3.8/scalar-kubernetes/BackupRDB.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Back up an RDB in a Kubernetes environment

This guide explains how to create a backup of a single relational database (RDB) that ScalarDB or ScalarDL uses in a Kubernetes environment. Please note that this guide assumes that you are using a managed database from a cloud services provider.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Back up and restore ScalarDB or ScalarDL data in a Kubernetes environment

This guide explains how to backup and restore ScalarDB or ScalarDL data in a Kubernetes environment. Please note that this guide assumes that you are using a managed database from a cloud services provider as the backend database for ScalarDB or ScalarDL. The following is a list of the managed databases that this guide assumes you might be using:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
- Deprecated
---

# Guidelines for creating an AKS cluster for ScalarDB Server

This document explains the requirements and recommendations for creating an Azure Kubernetes Service (AKS) cluster for ScalarDB Server deployment. For details on how to deploy ScalarDB Server on an AKS cluster, see [Deploy ScalarDB Server on AKS](ManualDeploymentGuideScalarDBServerOnAKS.mdx).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Guidelines for creating an AKS cluster for ScalarDL Ledger

This document explains the requirements and recommendations for creating an Azure Kubernetes Service (AKS) cluster for ScalarDL Ledger deployment. For details on how to deploy ScalarDL Ledger on an AKS cluster, see [Deploy ScalarDL Ledger on AKS](ManualDeploymentGuideScalarDLOnAKS.mdx).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Guidelines for creating an AKS cluster for ScalarDL Ledger and ScalarDL Auditor

This document explains the requirements and recommendations for creating an Azure Kubernetes Service (AKS) cluster for ScalarDL Ledger and ScalarDL Auditor deployment. For details on how to deploy ScalarDL Ledger and ScalarDL Auditor on an AKS cluster, see [Deploy ScalarDL Ledger and ScalarDL Auditor on AKS](ManualDeploymentGuideScalarDLAuditorOnAKS.mdx).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Guidelines for creating an AKS cluster for Scalar products

To create an Azure Kubernetes Service (AKS) cluster for Scalar products, refer to the following:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Create a bastion server

This document explains how to create a bastion server and install some tools for the deployment of Scalar products.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
- Deprecated
---

# (Deprecated) Guidelines for creating an EKS cluster for ScalarDB Server

:::warning
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Guidelines for creating an EKS cluster for ScalarDB Cluster

This document explains the requirements and recommendations for creating an Amazon Elastic Kubernetes Service (EKS) cluster for ScalarDB Cluster deployment. For details on how to deploy ScalarDB Cluster on an EKS cluster, see [Deploy ScalarDB Cluster on Amazon EKS](ManualDeploymentGuideScalarDBClusterOnEKS.mdx).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Guidelines for creating an EKS cluster for ScalarDL Ledger

This document explains the requirements and recommendations for creating an Amazon Elastic Kubernetes Service (EKS) cluster for ScalarDL Ledger deployment. For details on how to deploy ScalarDL Ledger on an EKS cluster, see [Deploy ScalarDL Ledger on Amazon EKS](ManualDeploymentGuideScalarDLOnEKS.mdx).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Guidelines for creating an EKS cluster for ScalarDL Ledger and ScalarDL Auditor

This document explains the requirements and recommendations for creating an Amazon Elastic Kubernetes Service (EKS) cluster for ScalarDL Ledger and ScalarDL Auditor deployment. For details on how to deploy ScalarDL Ledger and ScalarDL Auditor on an EKS cluster, see [Deploy ScalarDL Ledger and ScalarDL Auditor on Amazon EKS](ManualDeploymentGuideScalarDLAuditorOnEKS.mdx).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Guidelines for creating an Amazon EKS cluster for Scalar products

To create an Amazon Elastic Kubernetes Service (EKS) cluster for Scalar products, refer to the following:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# How to Create Private Key and Certificate Files for Scalar Products

This guide explains how to create private key and certificate files for Scalar products.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# How to get the container images of Scalar products

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# How to use the container images

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Collecting logs from Scalar products on a Kubernetes cluster

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Monitoring Scalar products on a Kubernetes cluster

This document explains how to deploy Prometheus Operator on Kubernetes with Helm. After following this document, you can use Prometheus, Alertmanager, and Grafana for monitoring Scalar products on your Kubernetes environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Deploy ScalarDB Cluster on Amazon Elastic Kubernetes Service (EKS)

This guide explains how to deploy ScalarDB Cluster on Amazon Elastic Kubernetes Service (EKS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
- Deprecated
---

# [Deprecated] Deploy ScalarDB Server on Azure Kubernetes Service (AKS)

This guide explains how to deploy ScalarDB Server on Azure Kubernetes Service (AKS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
- Deprecated
---

# Deploy ScalarDB Server on Amazon Elastic Kubernetes Service (EKS)

This guide explains how to deploy ScalarDB Server on Amazon Elastic Kubernetes Service (EKS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Deploy ScalarDL Ledger and ScalarDL Auditor on Azure Kubernetes Service (AKS)

This guide explains how to deploy ScalarDL Ledger and ScalarDL Auditor on Azure Kubernetes Service (AKS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Deploy ScalarDL Ledger and ScalarDL Auditor on Amazon Elastic Kubernetes Service (EKS)

This guide explains how to deploy ScalarDL Ledger and ScalarDL Auditor on Amazon Elastic Kubernetes Service (EKS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Deploy ScalarDL Ledger on Azure Kubernetes Service (AKS)

This document explains how to deploy **ScalarDL Ledger** on Azure Kubernetes Service (AKS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Deploy ScalarDL Ledger on Amazon Elastic Kubernetes Service (EKS)

This document explains how to deploy **ScalarDL Ledger** on Amazon Elastic Kubernetes Service (EKS).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Configure Network Peering for ScalarDL Auditor Mode

This document explains how to connect multiple private networks for ScalarDL Auditor mode to perform network peering. For ScalarDL Auditor mode to work properly, you must connect ScalarDL Ledger to ScalarDL Auditor.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Production checklist for ScalarDB Cluster

This checklist provides recommendations when deploying ScalarDB Cluster in a production environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Production checklist for ScalarDL Auditor

This checklist provides recommendations when deploying ScalarDL Auditor in a production environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Production checklist for ScalarDL Ledger

This checklist provides recommendations when deploying ScalarDL Ledger in a production environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Production checklist for Scalar products

To make your deployment ready for production, refer to the following:
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-3.8/scalar-kubernetes/RegularCheck.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Components to Regularly Check When Running in a Kubernetes Environment

Most of the components deployed by manual deployment guides are self-healing with the help of the managed Kubernetes services and Kubernetes self-healing capability. There are also configured alerts that occur when some unexpected behavior happens. Thus, there shouldn't be so many things to do day by day for the deployment of Scalar products on the managed Kubernetes cluster. However, it is recommended to check the status of a system on a regular basis to see if everything is working fine. Here is the list of things you might want to do on a regular basis.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Restore databases in a Kubernetes environment

This guide explains how to restore databases that ScalarDB or ScalarDL uses in a Kubernetes environment. Please note that this guide assumes that you are using a managed database from a cloud services provider as the backend database for ScalarDB or ScalarDL.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Set up a database for ScalarDB/ScalarDL deployment

This guide explains how to set up a database for ScalarDB/ScalarDL deployment on cloud services.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Set up a database for ScalarDB/ScalarDL deployment on AWS

This guide explains how to set up a database for ScalarDB/ScalarDL deployment on AWS.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Set up a database for ScalarDB/ScalarDL deployment on Azure

This guide explains how to set up a database for ScalarDB/ScalarDL deployment on Azure.
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-3.8/scalar-kubernetes/alerts/Envoy.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Envoy Alerts

## EnvoyClusterDown
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
---

# Ledger Alerts

## LedgerClusterDown
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
tags:
- Enterprise Standard
- Enterprise Premium
---

# Scalar Alerts

This section covers the types of alerts and what actions need to be taken.
Expand Down

0 comments on commit d714274

Please sign in to comment.