Sider Documentation

Sider Documentation

  • Enterprise
  • News
  • Sider Top

›Enterprise

Getting Started

  • Home
  • Intro Videos
  • Setting up Sider
  • Dashboard Overview
  • Repository Settings
  • Custom Analysis Configuration
  • Recommended Ruleset
  • Working with Issues
  • Permissions
  • Skip Analyzing

Analysis Tools

    Ruby

    • RuboCop
    • Reek
    • Querly
    • Rails Best Practices
    • Brakeman
    • HAML-Lint
    • Slim-Lint (beta)

    Java

    • Checkstyle
    • PMD
    • JavaSee

    Kotlin

    • ktlint (beta)
    • detekt (beta)

    JavaScript and Flavors

    • ESLint
    • JSHint
    • TyScan
    • CoffeeLint
    • TSLint (deprecated)

    CSS

    • stylelint
    • SCSS-Lint (deprecated)

    PHP

    • PHP_CodeSniffer
    • PHPMD
    • Phinder

    Python

    • Flake8
    • Pylint (beta)

    Swift

    • SwiftLint

    Go

    • GolangCI-Lint

    C/C++

    • Cppcheck
    • cpplint
    • Clang-Tidy (beta)

    C#

    • FxCop (beta)

    Shell script

    • ShellCheck

    Dockerfile

    • hadolint

    Markdown

    • remark-lint

    Others

    • Goodcheck
    • Misspell
    • LanguageTool (beta)
    • PMD CPD (beta)

Custom Rules

  • Intro to Custom Rules
  • Goodcheck
  • Tips & Tricks

Advanced Settings

  • Inline Comments
  • Private Dependencies
  • Restricting access to Close button
  • Transferring a repository

Billing and Plans

  • Billing and Plans

Troubleshooting

  • Troubleshooting

Enterprise

  • Outline
  • System Overview
  • Installation
  • Configuration
  • Operation
  • Update
  • Load Balancer
  • MySQL
  • Redis
  • MinIO
  • Amazon S3
  • GitHub Enterprise Server
  • Clustering
  • Example Deployments

    • Single Node with Docker Compose

    Releases

    • Overview
    • January 2021
    • December 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • February 2020
    • January 2020
    • November 2019
    • Older releases

News

  • 2021
  • 2020
  • 2019
Edit

Operation

Start, Stop, and Restart Sider Enterprise

How to start services

Sider Enterprise services run as Docker containers, so you can start the services on any platforms which support Docker. Sider Enterprise consists of two types of daemon containers and one type of batch container. The former includes sideci-web and sideci-worker, and the latter is Runners.

sideci-web is a web application service. You should pass these parameters to your Docker runtime.

  • COMMAND: bundle exec puma
  • Published port: 80:3000 (You can change the value 80 to an arbitrary port number)
  • Environment variables: See Sider Enterprise Configuration

This is an example of how to start sideci-web.

docker run \
  --detach \
  --restart=always \
  --env-file=ENV_FILE \
  --publish=80:3000 \
  480130971618.dkr.ecr.us-east-1.amazonaws.com/sideci_onprem:TAG \
  bundle exec puma

sideci-worker is responsible for processing background jobs. You should pass these parameters to your Docker runtime.

  • COMMAND: bundle exec sidekiq
  • Environment variables: See Sider Enterprise Configuration

This is an example of how to start sideci-worker.

docker run \
  --detach \
  --restart=always \
  --env-file=ENV_FILE \
  --volume=/var/run/docker.sock:/var/run/docker.sock:ro \
  480130971618.dkr.ecr.us-east-1.amazonaws.com/sideci_onprem:TAG \
  bundle exec sidekiq

The containers of Runners will be created by sideci-web or sideci-worker, so you don't have to care about running Runners. However, these containers will consume CPU, memory, and the disk storage space, so it's recommended to watch these metrics.

How to stop and restart services

All Sider Enterprise services do not store persistent data within their containers, so you can stop the containers by deleting them. If you want to restart the services, all you need it just recreate them.

Make users administrator

Sider Enterprise administrators can do the followings on the /admin page:

  • To review all the users, repositories, organizations, and analyses
  • To make other users administrators

In order to make users administrators, run the following command:

docker run --env-file=ENV_FILE 480130971618.dkr.ecr.us-east-1.amazonaws.com/sideci_onprem:TAG bundle exec rails admin:promote[USERNAME]

Replace USERNAME with a GitHub login name.

The specified USERNAME must exist on the Sider database. Make sure the user sign up on Sider in advance.

Register users on Sider manually

If you configure Sider with RESTRICT_SIGN_UP, you will have to create users on Sider manually. Visit the path /admin/users/new for the Sider's host, and you will be supposed to input username and locale for a new user. The specified username must exist on your GitHub Enterprise Server.

Collect debug logs

Sider Enterprise services write debug logs to the standard output. You can collect the logs via Docker logging drivers.

Monitor Sider Enterprise

We recommend you should watch these metrics to notice performance issues and unexpected errors.

  • Disk storage space
  • CPU utilization
  • Memory utilization
  • The number of analyses on the /admin/stats page
  • The periodic requests to /api/health_check should respond with HTTP status 200

In addition, these metrics for other services should be also monitored because Sider Enterprise heavily uses them.

  • Disk storage space on MySQL
  • Disk storage space on MinIO

Remove old Docker images

You might want to remove old Docker images related to Sider Enterprise because they consume disk space. This is an example command to do that (replace RUNNER_VERSION with the latest Runner version. You can see the version on our release page):

docker image ls --format '{{.Repository}}:{{.Tag}}' \
  | grep  sider/runner_ \
  | grep -v RUNNER_VERSION \
  | xargs docker rmi --force

Also, docker image prune will help you to remove dangling images. Learn more Prune unused Docker objects for pruning images.

← ConfigurationUpdate →
  • Start, Stop, and Restart Sider Enterprise
    • How to start services
    • How to stop and restart services
  • Make users administrator
  • Register users on Sider manually
  • Collect debug logs
  • Monitor Sider Enterprise
  • Remove old Docker images
Sider Documentation
Docs
Getting StartedAnalysis ToolsEnterprise
Sider
Sider TopTerms of ServicePrivacy
Social
BlogGitHubStar
Copyright © 2021 Sider, Inc.