dogu.json

{
  "Name": "official/sonar",
  "Version": "25.12.0-9",
  "DisplayName": "SonarQube",
  "Description": "SonarQube is an open source quality management platform, dedicated to continuously analyze and measure source code quality",
  "Category": "Development Apps",
  "Tags": [
    "warp",
    "code",
    "quality",
    "analysis"
  ],
  "Logo": "https://cloudogu.com/images/dogus/sonarqube.png",
  "Url": "http://www.sonarqube.org/",
  "Image": "registry.cloudogu.com/official/sonar",
  "Dependencies": [
    {
      "type": "dogu",
      "name": "postgresql"
    },
    {
      "type": "dogu",
      "name": "cas",
      "Version": ">=7.0.5.1-6"
    },
    {
      "type": "dogu",
      "name": "nginx"
    },
    {
      "type": "dogu",
      "name": "postfix"
    }
  ],
  "Volumes": [
    {
      "Name": "data",
      "Path": "/opt/sonar/data/",
      "Owner": "1000",
      "Group": "1000",
      "NeedsBackup": true
    },
    {
      "Name": "qualityprofiles",
      "Path": "/var/lib/qualityprofiles",
      "Owner": "1000",
      "Group": "1000",
      "NeedsBackup": false
    },
    {
      "Name": "extensions",
      "Path": "/opt/sonar/extensions",
      "Owner": "1000",
      "Group": "1000",
      "NeedsBackup": true
    },
    {
      "Name": "localConfig",
      "Path": "/var/ces/config",
      "Owner": "1000",
      "Group": "1000",
      "NeedsBackup": true
    }
  ],
  "ServiceAccounts": [
    {
      "Type": "postgresql"
    },
    {
      "Type": "cas",
      "Params": [
        "cas"
      ]
    }
  ],
  "Configuration": [
    {
      "Name": "sonar.updatecenter.url",
      "Description": "Set custom SonarQube UpdateCenter URL",
      "Optional": true
    },
    {
      "Name": "sonar.plugins.default",
      "Description": "Comma separated list of plugin names to install on start",
      "Optional": true
    },
    {
      "Name": "sonar.web.sso.refreshIntervalInMinutes",
      "Description": "The interval used to know when to refresh name, email, and groups. During this interval, if for instance the name of the user is changed in the header, it will only be updated after X minutes.",
      "Optional": true,
      "Default": "5"
    },
    {
      "Name": "sonar.web.sessionTimeoutInMinutes",
      "Description": "Inactive session timeout (in minutes). The maximum time a user can remain idle (no activity) before the session ends. The minimum value is 6, the maximum value 129600 (90 days).",
      "Optional": true,
      "Default": "1440"
    },
    {
      "Name": "container_config/swap_limit",
      "Description": "Limits the container's swap memory usage. Use zero or a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte). 0 will disable swapping.",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "container_config/java_sonar_main_max_ram_percentage",
      "Description": "Limits the heap stack size of the Sonar main process to the configured percentage of the available physical memory when the container has more than approx. 250 MB of memory available. Is only considered when a memory_limit is set. Use a valid float value with decimals between 0 and 100 (f. ex. 55.0 for 55%). Default value for Sonar main: 25%",
      "Optional": true,
      "Default": "25.0",
      "Validation": {
        "Type": "FLOAT_PERCENTAGE_HUNDRED"
      }
    },
    {
      "Name": "container_config/java_sonar_main_min_ram_percentage",
      "Description": "Limits the heap stack size of the Sonar main process to the configured percentage of the available physical memory when the container has less than approx. 250 MB of memory available. Is only considered when a memory_limit is set. Use a valid float value with decimals between 0 and 100 (f. ex. 55.0 for 55%). Default value for Sonar main: 50%",
      "Optional": true,
      "Default": "50.0",
      "Validation": {
        "Type": "FLOAT_PERCENTAGE_HUNDRED"
      }
    },
    {
      "Name": "container_config/java_sonar_web_max_min_ram_percentage",
      "Description": "Limits the heap stack size of the Sonar web background process to the configured percentage of the available physical memory. Is only considered when a memory_limit is set. Use a valid float value with decimals between 0 and 100 (f. ex. 55.0 for 55%). Default value for Sonar web: 10%",
      "Optional": true,
      "Default": "10.0",
      "Validation": {
        "Type": "FLOAT_PERCENTAGE_HUNDRED"
      }
    },
    {
      "Name": "container_config/java_sonar_search_max_min_ram_percentage",
      "Description": "Limits the heap stack size of the Sonar search background process to the configured percentage of the available physical memory. Is only considered when a memory_limit is set. Use a valid float value with decimals between 0 and 100 (f. ex. 55.0 for 55%). Default value for Sonar search: 10%",
      "Optional": true,
      "Default": "10.0",
      "Validation": {
        "Type": "FLOAT_PERCENTAGE_HUNDRED"
      }
    },
    {
      "Name": "container_config/java_sonar_cengine_max_min_ram_percentage",
      "Description": "Limits the heap stack size of the Sonar compute engine background process to the configured percentage of the available physical memory. Is only considered when a memory_limit is set. Use a valid float value with decimals between 0 and 100 (f. ex. 55.0 for 55%). Default value for Sonar compute engine: 10%",
      "Optional": true,
      "Default": "10.0",
      "Validation": {
        "Type": "FLOAT_PERCENTAGE_HUNDRED"
      }
    },
    {
      "Name": "amend_projects_with_ces_admin_permissions",
      "Description": "If set to a current timestamp, the ces-admin group will be enabled to administer all projects. The timestamp has to be in the format `YYYY-MM-DD hh:mm:ss` (e.g. `2025-03-20 09:30:00`). The Dogu saves the timestamp of the last execution internally and compares this timestamp with the timestamp from the configuration. If the timestamp entered in the configuration is “newer”, the projects are corrected when the dogu is restarted.",
      "Optional": true
    },
    {
      "Name": "logging/root",
      "Description": "Set the root log level to one of ERROR, WARN, INFO, DEBUG, TRACE.",
      "Optional": true,
      "Default": "INFO",
      "Validation": {
        "Type": "ONE_OF",
        "Values": [
          "WARN",
          "DEBUG",
          "INFO",
          "ERROR"
        ]
      }
    },
    {
      "Name": "container_config/memory_limit",
      "Description": "Limits the container's memory usage. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      },
      "Default": "2176m"
    },
    {
      "Name": "container_config/memory_request",
      "Description": "Requests the container's minimal memory requirement. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      },
      "Default": "2176m"
    },
    {
      "Name": "container_config/cpu_core_limit",
      "Description": "Limits the container's CPU core usage. Use a positive floating value describing a fraction of 1 CPU core. When you define a value of '0.5', you are requesting half as much CPU time compared to if you asked for '1.0' CPU.",
      "Optional": true
    },
    {
      "Name": "container_config/cpu_core_request",
      "Description": "Requests the container's minimal CPU core requirement. Use a positive floating value describing a fraction of 1 CPU core. When you define a value of '0.5', you are requesting half as much CPU time compared to if you asked for '1.0' CPU.",
      "Optional": true,
      "Default": "0.25"
    },
    {
      "Name": "container_config/storage_limit",
      "Description": "Limits the container's ephemeral storage usage. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "container_config/storage_request",
      "Description": "Requests the container's minimal ephemeral storage requirement. Use a positive integer value followed by one of these units [b,k,m,g] (byte, kibibyte, mebibyte, gibibyte).",
      "Optional": true,
      "Validation": {
        "Type": "BINARY_MEASUREMENT"
      }
    },
    {
      "Name": "profiles/url",
      "Description": "The url to download a zip file containing quality profiles to be imported.",
      "Optional": true
    },
    {
      "Name": "profiles/user",
      "Description": "The user to download the quality profiles to be imported.",
      "Optional": true
    },
    {
      "Name": "profiles/password",
      "Description": "The password to download quality profiles to be imported.",
      "Optional": true,
      "Encrypted": true
    },
    {
      "Name": "profiles/retry_limit",
      "Description": "The number of attempts to try to download the quality profiles.",
      "Optional": true,
      "Default": "5"
    },
    {
      "Name": "profiles/allow_insecure",
      "Description": "A flag to skip HTTPS certificate checks. Useful for development with self signed certificates.",
      "Optional": true,
      "Default": "false"
    },
    {
      "Name": "profiles/force_upload",
      "Description": "A flag to indicate that the profile archive should always be uploaded. Use this only if profiles got deleted manually in the dogu. Don't forget to turn this option to false after using it.",
      "Optional": true,
      "Default": "false"
    },
    {
      "Name": "remove_product_news",
      "Description": "A flag to indicate to remove the product news widget and the outgoing getbeamer.com call that comes with it. This flag will lead to changes on container files that will only recover on container recreation.",
      "Optional": true,
      "Default": "false"
    }
  ],
  "HealthChecks": [
    {
      "Type": "tcp",
      "Port": 8080
    },
    {
      "Type": "state"
    }
  ],
  "ExposedCommands": [
    {
      "Name": "post-upgrade",
      "Command": "/post-upgrade.sh"
    },
    {
      "Name": "upgrade-notification",
      "Command": "/upgrade-notification.sh"
    },
    {
      "Name": "pre-upgrade",
      "Command": "/pre-upgrade.sh"
    }
  ]
}