Ongoing tasks

Certain tasks may repeat during the life of the system. These tasks may be due to a need to troubleshoot an issue, support new integration systems, or perform maintenance.

Check for newer SD Elements releases

Retrieve a list of available application updates with the steps below.

Prerequisites:

  • Console or SSH access to the instance

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

  • Outbound HTTPS access to updates.sdelements.com

Steps:

  1. Access the SD Elements server console as a member of the sde_admin group

  2. Run the following command:

    sde update --list

The process returns a list of available SD Elements releases.

Upgrade the SD Elements updater

Keep the SD Elements updater current to access the latest configuration capabilities and stability fixes.

Prerequisites:

  • Console or SSH access to the instance

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

  • Outbound HTTPS access to updates.sdelements.com

Steps:

  1. Access the SD Elements server console and get superuser privileges (sudo access)

  2. Run the following two command:

    creds="$(grep -Po "(?⇐^pypi_url=https://)(.:.)(?=@)" /docs/sde/updater.cfg)" sudo bash -c "creds=${creds} umask 0002 && pip install --upgrade sde-admin --index=https://${creds}@updates.sdelements.com/sde/prod/4/pypi/simple/"

The python package sde_admin is updated to the latest version. The most recent version of the SD Elements updater is installed.

Upgrade to a newer SD Elements release

Follow the steps below to upgrade a server to a later release of SD Elements.

Prerequisites:

  • Console or SSH access to the instance

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

  • Outbound HTTPS access to updates.sdelements.com and anvil.sdelements.com

Steps:

  1. Access the SD Elements server console and get superuser privileges (sudo access)

  2. Run the following command:

    sudo sde update

The process may take a few minutes as all OS and SDE updates are downloaded from the SD Elements server. If a newer release is detected, the upgrade will prompt the user before proceeding. The existing SD Elements release is left intact on the server until manually removed or purged with the sde command.

 If an error occurs, or there is an unexpected result, the system will roll back to the "last known good" release.

Check for newer system packages

Retrieve a list of system packages that can be upgraded using the following steps:

Prerequisites:

  • Console or SSH access to the instance

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

  • Outbound HTTPS access to anvil.sdelements.com

Steps:

  1. Access the SD Elements server console and get superuser privileges (sudo access)

  2. Run the following command:

    sudo yum check-update

The process returns a list of all package updates.

Update system packages

Update system packages to their latest available version.

Prerequisites:

  • Console or SSH access to the instance

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

  • Outbound HTTPS access to anvil.sdelements.com

Steps:

  1. Access the SD Elements server console and get superuser privileges (sudo access)

  2. Run the following command:

    sudo yum update

Confirm that the update should proceed by pressing the 'y' key. The process may take a few minutes. The system packages are then updated to the latest version.

Apply custom system configuration

System configuration is managed through /docs/sde/custom.yaml settings. Apply these settings by following the steps below.

 Configuration and customization changes performed without corresponding changes in custom.yaml can and most likely will be overwritten unless explicitly excluded in the aforementioned custom.yaml file.
Prerequisites:

  • Console or SSH access to the instance

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

Steps:

  1. Access the SD Elements server console as a member of the sde_admin group

  2. Run the following command:

  3. Update the file /etc/sde/custom.yaml with the desired changes. The list of supported options for the installed release can be found in /etc/sde/custom.yaml.example on the system or a generic list of options are listed in section System configuration options.

  4. Run:

    sudo sde reprovision --offline-mode

The process may take a few minutes. The system will be reconfigured according to the custom.yaml file.

Trust a TLS/SSL certificate

Follow the steps below to configure the system for a new TLS/SSL certificate.

Prerequisites:

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

  • TLS/SSL Certificate Authority (CA) certificate file in PEM format.

Steps:

  1. Upload the certificate to the server. We recommend placing them in the directory /etc/sde/custom_ca_certs/, and use this as an example.

  2. Access the SD Elements server console as a member of the sde_admin group

  3. Ensure the option role::server::custom_ca_certs in /etc/sde/custom.yaml is active and configured for the location of the certificate.

  4. Run the following commands:

    sudo sde reprovision --offline-mode
sudo sde supervisor restart all

The system trust store will be updated to include the certificate. All SDE Integrations will now include the new Certicifate Authority when validating TLS and SSL secured connections.

Verify a TLS/SSL certificate is trusted

Check that a TLS/SSL certificate is trusted with the following steps:

Prerequisites:

  • Console or SSH access to the instance

  • SSH credentials for a valid user on the system

  • Fully qualified hostname and port (usually 443) for the target server

Steps:

  1. Access the SD Elements server SSH console

  2. Verify the system’s configuration by checking that it has been successfully configured to trust a remote certificate signed by Custom Certificate Authority. Use the steps below:

    • If you have direct access to hostname:port, run:

      openssl s_client -connect hostname:port

    • If you rely on a proxy to access the hostname from the SD Elements Server, run:

      curl https://hostname:port/

  3. Verify the application’s configuration by checking that it is set up correctly for a new certificate. Use the steps below:

    • Log in to the SD Elements web application.

    • Open an ALM connector configured for hostname:port and click "Test Connection".

The new certificate is now verified.

Examine logs

To diagnose application issues follow the steps below to access the application logs:

Prerequisites:

  • Console or SSH access to the instance

  • User credentials to log into the box (user needs to be a member of the sde and sde_admin groups)

Steps:

  1. Access the SD Elements server SSH console

  2. Change to the logs directory:

    cd /docs/sde/log/

  3. Examine the log files

    • Use the tail command to watch logs as they occur

      tail -f /docs/sde/log/sdlc.log

    • Search for certain TEXT in logs by using grep

      grep -i TEXT /docs/sde/log/apache_error_sde_VERSION.log

Refer to Log files for details on which log file to examine.

 When sharing details with SD Elements Support, use tail -100 logfile to collect context about an unexpected event. This command returns the last 100 lines from logfile.

Remove older application releases

The system retains older application releases and their data after an upgrade. To keep only recent releases and delete the others follow the steps below.

Prerequisites:

  • SSH credentials for sde_admin

  • The number of recent releases to keep.

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. To keep the 2 most recent releases, for example, run:

    sde manage_releases keep 2

All but the two most recent releases are kept on the server. Older releases and their data are deleted.

Open the application shell

The application shell provides low-level access to the data elements and functionality using custom script. Open the shell by following the steps below.

Prerequisites:

  • SSH credentials for sde_admin

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run sde manage_django shell_plus. A Django shell opens with direct access to the application.

  3. Type the script into the console and press <enter> after each statement.

  4. Press Ctrl-D or type quit() to stop the shell.

All changes made in the shell are permanent.

List system component versions

Follow the steps below to check the version of SD Elements running on the server as well as other components.

Prerequisites:

  1. SSH credentials for sde_admin

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run

    sde version

The version of SD Elements is printed to the console. In the example below the version of sde is 4.12.36:

[sde_admin@server ~]# sde version
sde> Component Versions:
sde> python           -> 2.7.14
sde> sde              -> 4.12.36
sde> puppet           -> 4.10.10
sde> puppet_env       -> 4.11.57
sde> sde_admin        -> 1.4.10

Confirm the version for the integration components

Follow the steps below to output the version of the integration components sdetools.

Prerequisites:

  1. SSH credentials for sde_admin

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run the following command:

    sde pip live freeze | grep sdetools

The version of sdetools is printed to the console.

Activate a different application release

Prior releases are kept on the server after an upgrade. During testing, it may need to revert to an earlier release. To switch to a different application release of SD Elements, follow the steps below.

Prerequisites:

  • SSH credentials for sde_admin

  • The fully qualified application release name. For example, "4.12.13"

  • The application release is installed on the server

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run the following command:

    sde activate_release 4.12.13

The current release of SD Elements and its data are left intact on the server. The active release of SD Elements is changed to the selected version and the server is reprovisioned. The application data contains the information stored when the selected release was last used.

Turn on maintenance mode

Pause the application and inform users that it is temporarily unavailable with the steps below.

Prerequisites:

  • SSH credentials for sde_admin

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run the following command:

    sde maintenance on

Users are greeted with a web page stating the application is offline. All HTTP responses are sent with error 503.

maintenance page.png

Turn off maintenance mode

Resume the application for users using the steps below.

Prerequisites:

  • SSH credentials for sde_admin

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run the following command:

    sde maintenance off

The application is back to normal operation.

Reset the password of an application user

To reset the password of a web application user, follow the steps below.

Prerequisites:

  • SSH credentials for sde_admin or sudo access.

  • User email address. For example: user@example.com

Steps:

  1. Access the SD Elements server SSH console as sde_admin.

  2. On the command line, run the following command:

    sde manage_django changepassword user@example.com

  3. Enter the new password when prompted.

The password is reset.

Grant super user access to an application user

Access to SD Elements application data and settings is generally controlled by the in-app Global and Project roles, as well as group and business unit membership. However, there are certain capabilities that are reserved to a special class of user, a Super User.

By default every organization has a single Super User. The Super User has full application access, including the ability to modify the following items:

  • Task Statuses

  • Domain Settings

  • Single Sign-On settings

  • Custom Application and Project Attributes

The default super user is "support@sdelements.com". To grant super user access to an application user, such as "admin@example.com", follow the steps below:

Prerequisites:

  • SSH credentials for sde_admin or sudo access

Steps:

  1. Open the application shell

  2. Type the following in your shell and replace the example email address with the one you wish to affect in your instance:

    from users.models import User
u = User.objects.get(username="admin@example.com")
u.is_superuser = True
u.save()
quit()

The user "admin@example.com" is given super access. Additional menu options and capabilities are possible for the user.

 To disable super user access change u.is_superuser = True to u.is_superuser = False in the above script.

results matching ""

    No results matching ""