# account

CD:
[![Dev CD Pipeline](https://github.com/tidbcloud/account/actions/workflows/dev-cd.yaml/badge.svg)](https://github.com/tidbcloud/account/actions/workflows/dev-cd.yaml)
[![Staging CD Pipeline](https://github.com/tidbcloud/account/actions/workflows/staging-cd.yaml/badge.svg)](https://github.com/tidbcloud/account/actions/workflows/staging-cd.yaml)
[![Prod CD Pipeline](https://github.com/tidbcloud/account/actions/workflows/prod-cd.yaml/badge.svg)](https://github.com/tidbcloud/account/actions/workflows/prod-cd.yaml)

Manual CD:
[![Manual CD Pipeline](https://github.com/tidbcloud/account/actions/workflows/manual-cd.yaml/badge.svg)](https://github.com/tidbcloud/account/actions/workflows/manual-cd.yaml)


![account](./docs/static/account_svc.png)

# DBaaS

Backend services for our DBaaS. DBaaS is our managed cloud offering.

## Organization

The [DBaaS architecture](./docs/development/architecture.md) describes the system landscape, the code of
components/utilities are separate in the following directories or sub-repositories:

* [central](./central): the service is a portal service(serve a http endpoint), used by customer user.
* [management-portal](./admin): the service is a portal service(serve a http endpoint), used by administrator user.
* [deploy](./deploy): deployment script
* [pkg](./pkg): This code is designed to be shared by different services
* [pkgv2](./pkgv2): This code is designed to be shared by all server/service/module. These code should don't depend on
  any business code or configuration.
* [template](./template): This is a service template that is used to generate operations and central
* [tools](./tools): This installs go linting tools

### Setup

1. [Create a PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and save it into `.pingcap/github_token`.
2. [Install docker](https://docs.docker.com/get-docker/)
3. Build docker image:

    ```bash
    $ make docker-build
    ```

## Documentation

- [DBaaS Development](./docs/development/README.md)
- [Customer Support](./docs/customer/README.md)
- [DBaaS Operations](./docs/operations/README.md)