Changing the database password

2 minute read

The procedure in this section is applicable for both single server and clustered server environments.

  1. In a clustered environment, shutdown all but one node in the cluster. In a single node environment, proceed to the next step.

  2. Disable server activities.

    Before you change the database password, the CloudBees CD/RO server must be inactive. This ensures no in-flight work is happening that could be reading or writing to a database instance leading to data consistency errors.

    To disable server activities complete the following actions on the CloudBees CD/RO server:

    • Disable the ECSCM:SentryMonitor schedule and all project schedules.

      1. From the main menu, navigate to the Platform Home Page.

      2. Select Electric Cloud from the Projects tab.

      3. Select the Schedules tab and disable all schedules, including the ECSCM-SentryMonitor schedule that runs the ECSCM:ElectricSentry procedure.

    • Make sure all jobs are stopped.

      1. From the main menu, navigate to the Platform Home Page.

      2. Select the Jobs tab.

      3. Review the jobs list and take action to stop all jobs.

    • Disable all resources so that no new job steps can run.

      1. From the main menu, navigate to the Resources list.

      2. Disable each resource by clearing its state from the Enabled column.

  3. Change the database password.

    Update the password on the node via the database configuration.

    • Via the command-line using

      ectool setDatabaseConfiguration --userName <user-name> --password <new-password>
    • Via the Automation Platform UI at Configurations > Database Configuration.

    • Via the setDatabaseConfiguration Perl API command.

      For clustered environments the updated configuration is automatically uploaded to ZooKeeper.
  4. Restart the node.

    • If using ectool to change the password, restart the node.

    • If using the UI option to change the password, the node automatically restarts.

  5. In a clustered environment, restart the rest of the nodes in the cluster.