Skip to content

Commit

Permalink
add deprecated warnings for outdated deployment methods (pingcap#3000)
Browse files Browse the repository at this point in the history
Co-authored-by: ti-srebot <66930949+ti-srebot@users.noreply.github.com>
  • Loading branch information
yikeke and ti-srebot authored Jul 6, 2020
1 parent cc49497 commit 83ba8b0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
comment: 'Rules for PingCAP docs'
comment: 'Markdownlint Rules for PingCAP docs'

# disable all by default
default: false
Expand Down
8 changes: 4 additions & 4 deletions deploy-test-cluster-using-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ aliases: ['/docs/dev/deploy-test-cluster-using-docker-compose/','/docs/dev/how-t

# TiDB Docker Compose Deployment

> **Warning:**
>
> The Docker Compose deployment method provided in this document is no longer maintained. If you want to test TiDB, it is recommended to refer to [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md) for deployment. For **production environment**, **do not use** Docker Compose for deployment, but [deploy TiDB with TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-operator).
This document describes how to quickly deploy a TiDB testing cluster with a single command using [Docker Compose](https://docs.docker.com/compose/overview).

With Docker Compose, you can use a YAML file to configure application services in multiple containers. Then, with a single command, you can create and start all the services from your configuration.

> **Warning:**
>
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-operator) in production.
## Prerequisites

Make sure you have installed the following items on your machine:
Expand Down
10 changes: 5 additions & 5 deletions test-deployment-using-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ aliases: ['/docs/dev/test-deployment-using-docker/','/docs/dev/how-to/deploy/orc

# Deploy TiDB Using Docker

This page shows you how to manually deploy a multi-node TiDB cluster on multiple machines using Docker.

To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md).

> **Warning:**
>
> This is for testing only. DO NOT USE in production! It is recommended to deploy TiDB using [TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-operator) in production.
> The Docker deployment method provided in this document is no longer maintained. If you want to test TiDB, it is recommended to refer to [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md) for deployment. For **production environment**, **do not use** Docker Compose for deployment, but [deploy TiDB with TiUP](/production-deployment-using-tiup.md) or [TiDB Operator in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/v1.1/deploy-tidb-operator).
This document shows you how to manually deploy a multi-node TiDB cluster on multiple machines using Docker.

To learn more, see [TiDB architecture](/architecture.md) and [Software and Hardware Recommendations](/hardware-and-software-requirements.md).

## Preparation

Expand Down

0 comments on commit 83ba8b0

Please sign in to comment.