Skip to main content
Version: v1.0

Deployment Guide

Seata Beginner Deployment Guide​

Seata has three roles: TC, TM and RM. TC (Server side) is deployed as a separate server, while TM and RM (Client side) are integrated by the business system.

Resource Directory Introduction​

Click to view. You can also select the corresponding resource directory according to the version branch.​

-client

Store client-side sql script (including undo_log table) and parameter configuration. -config-center Each configuration center parameter import script, config.txt (including server and client, formerly known as nacos-config.txt) is a genernal parameter file.

  • server

Store server-side database script (including lock_table, branch_table and global_table) and container configuration.

Precautions​

  • seata-spring-boot-starter
It has the built-in GlobalTransactionScanner automatic initialization function. If initialization is implemented externally, please refer to SeataAutoConfiguration to ensure that the dependencies loads orderly.
Data source automatic proxy is turned on by default, and it can be turned off by configuring seata.enable-auto-data-source-proxy: false.
  • spring-cloud-starter-alibaba-seata

View release notes.
2.1.0 embeds seata-all 0.7.1, 2.1.1 embeds seata-all 0.9.0, 2.2.0 embeds seata-spring-boot-starter 1.0.0, 2.2.1 embeds seata-spring- boot-starter 1.1.0

    Solutions for 2.1.0 and 2.1.1 compatible starter:
In the @SpringBootApplication annotation, exclude com.alibaba.cloud.seata.GlobalTransactionAutoConfiguration in spring-cloud-starter-alibaba-seata
  • Recommendations for spring-cloud-starter-alibaba-seata dependency configuration
            <dependency>
                 <groupId>io.seata</groupId>
                 <artifactId>seata-spring-boot-starter</artifactId>
             </dependency>
             <dependency>
                 <groupId>com.alibaba.cloud</groupId>
                 <artifactId>spring-cloud-starter-alibaba-seata</artifactId>
                 <exclusions>
                     <exclusion>
                         <groupId>io.seata</groupId>
                         <artifactId>seata-spring-boot-starter</artifactId>
                     </exclusion>
                 </exclusions>
             </dependency>

Start Server​

There are currently three server-side storage modes (store.mode): file, db. The file mode does not need to be changed and can be started directly. The following specifically explains the db startup steps.

Note: The file mode is a stand-alone mode. The global transaction session information is read and written in the memory and the local file root.data is persisted. So the performance is quite well;

The db mode is a high-availability mode. Global transaction session information is shared through db, but the corresponding performance is poor;

Step 1: Startup package​

  • Click to download.
  • Official DingTalk group (Group Number: 23171167, 1st group is already full, including 5,000 people, 2nd group, group 3: 32033786), QQ group (Group Number: 254657148, group 2: 216012363). Please download packages in the group sharing file.

Step 2: Create table (db only)​

Global transaction session information consists of three pieces of content, that is global transaction-->branch transaction-->global lock, corresponding to the tables global_table, branch_table, and lock_table.

Step 3: Modify store.mode​

Startup package: seata-->conf-->file.conf, modify store.mode="db" Source code: root directory-->seata-server-->resources-->file.conf, modify store.mode="db"

Step 4: Modify database connection attribute configuration​

Startup package: seata-->conf-->file.conf, modify store.db related properties. Source code: Root directory-->seata-server-->resources-->file.conf, modify store.db related properties.

Step 5: Start​

  • Source code startup: execute the main method in Server.java
  • Command to start: seata-server.sh -h 127.0.0.1 -p 8091 -m db -n 1 -e test
    -h: IP registered to the registration center
    -p: Server rpc listening port
    -m: Global transaction session information storage mode, file, db. Read startup parameters first
    -n: Server node. When there are multiple servers, each node needs to be distinguished to generate transactionIds in different intervals to avoid conflicts.
    -e: Multi-environment configuration please refers to https://seata.apache.org/docs/ops/multi-configuration-isolation/.

Note: It is recommended to allocate 2G of heap memory and 1G of off-heap memory.

Business system integration Client​

  • Depends on seata-all.
  • Depends on seata-spring-boot-starter, supporting yml and properties configuration (.conf can be deleted), and relies on seata-all internally.
  • Depends on spring-cloud-alibaba-seata, integrates seata internally, and implements xid transfer.

Step 2: Create undo_log table and configure parameters (AT mode only)​

Step 3: Data source proxy (coexistence of automatic and manual configuration is not supported)​

  1. If using seata-all

    • Starting from version 0.9.0, seata supports automatic proxy data sources.

      1.1.0: seata-all cancels the attribute configuration and switches it to the annotation @EnableAutoDataSourceProxy, and you can choose jdk proxy or cglib proxy
      1.0.0: client.support.spring.datasource.autoproxy=true
      0.9.0: support.spring.datasource.autoproxy=true

      If XA mode is used, @EnableAutoDataSourceProxy(dataSourceProxyMode = "XA")

    • For manual configuration, please refer to the example below

      @Primary
      @Bean("dataSource")
      public DataSource dataSource(DataSource druidDataSource) {
          //AT agent (choose one of the two)
          return new DataSourceProxy(druidDataSource);
          //XA proxy
          return new DataSourceProxyXA(druidDataSource)
      }

  2. If using seata-starter

    • When using automatic proxy data sources, you need to adjust the configuration file if you use XA mode application.properties 
      seata.data-source-proxy-mode=XA
      application.yml 
      seata:
        data-source-proxy-mode: XA
    • How to turn off the data source automatic proxy of seata-spring-boot-starter? application.properties 
      seata.enable-auto-data-source-proxy=false
      application.yml 
      seata:
        enable-auto-data-source-proxy: false

Step 4: Initialize GlobalTransactionScanner​

  • Manual
        @Bean
        public GlobalTransactionScanner globalTransactionScanner() {
            String applicationName = this.applicationContext.getEnvironment().getProperty("spring.application.name");
            String txServiceGroup = this.seataProperties.getTxServiceGroup();
            if (StringUtils.isEmpty(txServiceGroup)) {
                txServiceGroup = applicationName + "-fescar-service-group";
                this.seataProperties.setTxServiceGroup(txServiceGroup);
            }
   
            return new GlobalTransactionScanner(applicationName, txServiceGroup);
        }
  • Automatic
    You can introduce seata-spring-boot-starter, spring-cloud-starter-alibaba-seata and other jars

Step 5: Implement xid cross-service transfer​

  • Manual
    Refer to the various rpc implementation modules under the source code integration folder.
  • Automatic
    SpringCloud users can introduce spring-cloud-starter-alibaba-seata, and xid transfer has been implemented internally.