Splunk Cloud Platform

Splunk Cloud Platform Admin Manual

Use the Maintenance dashboard

The Maintenance dashboard shows upcoming and past maintenance windows for Splunk initiated changes. Currently, the Maintenance dashboard only displays Splunk platform upgrade information. Splunk is working to display other maintenance information in this dashboard.

The Maintenance dashboard does not display any maintenance information for AWS GovCloud Splunk Cloud Platform deployments.

Prerequisite

The Maintenance dashboard requires token authentication to be enabled. See Enable or disable token authentication to learn how.

Enabling token authentication doesn't impact CMC availability and requires no maintenance or downtime.

If you're using a Splunk Cloud Platform version lower than 9.0.2208 and SAML authentication, the Maintenance dashboard requires authentication extensions to be enabled or an identity provider that supports Attribute Query Request. See Configure Splunk Cloud Platform to use SAML for authentication tokens to learn more.

Review next maintenance window

If you have a scheduled maintenance window, you'll see a panel with information about your next maintenance window. This panel provides a timestamp, maintenance ID number, and progress timeline.

Select Configure global banner to get a sample message you can use to display a global banner that informs users about the next maintenance window.

Review upcoming and past maintenance windows

You can review upcoming and past maintenance windows in the Maintenance dashboard. Filter by Upcoming, Past, or All using the dropdown selection. The default display shows Upcoming maintenance windows.

The Upcoming filter shows upcoming maintenance windows for the next 30 days. The Past filter shows past maintenance windows for the past 180 days.

If there are no maintenance windows in this dashboard, there are no scheduled maintenance windows that are supported by this dashboard. See the following table for more maintenance type information.

The Maintenance windows table shows maintenance windows and their following details:

Field Description
ID Unique ID for the maintenance window.
Maintenance type Splunk Cloud Service has three classes of maintenance types:
  • Service Updates
  • Routine Maintenance
  • Emergency Maintenance

See https://www.splunk.com/en_us/legal/splunk-cloud-service-maintenance-policy.html?locale=en_us to learn more.

Operation type Type of maintenance being performed. Currently, only the Splunk Upgrade operation type is shown. The Splunk Upgrade operation type refers to a Splunk Cloud Platform version upgrade. This operation type belongs to the service updates category of maintenance types.
Start time Refers to when the maintenance occurred for Past maintenance windows and refers to when the maintenance will occur for Upcoming maintenance windows. The start time is the local time that your Splunk Cloud Platform stack is set to.
Status The current state of the maintenance window. The maintenance window status is updated at around 7:00pm PST/PDT daily, and does not reflect real time status.
Duration The length of time the maintenance window will last. This value is an estimate for upcoming maintenance windows and an actual time for past maintenance windows.
Last updated When information for this maintenance window was last updated.
Operations Tasks required for maintenance.

Select a maintenance window to view a brief description of the maintenance being performed, operation type, target version, and timeline.

The Operation type and Status values come from the Admin Config Service (ACS) API. To learn more about viewing maintenance windows with the ACS API, see View maintenance windows in the Splunk Cloud Platform Admin Config Service Manual.

Review the upcoming maintenance window operations and timeline

The Upcoming maintenance dashboard displays operation details and a progress timeline panel. Select Operations to view a description, the operation type, and target version for the operation. Select Timeline to view a timeline for the operation.

In CMC version 3.6.0, the timestamps represent the last time the status was updated, which might not be when the actual event occurred.

The timeline provides the following statuses:

Status Description
Tentative Splunk has tentatively scheduled a maintenance window.
Scheduled Splunk has scheduled the maintenance window.
InProgress Splunk is currently performing the maintenance.
Completed Splunk has successfully completed at least one maintenance operation.
Canceled Splunk or the customer has canceled the maintenance window.

Add an upcoming maintenance window to your calendar

Select the calendar icon next to any scheduled upcoming maintenance window to download a .ics file. To add the event to your calendar, import this file to your calendar application.

The information in the .ics file does not update if any changes are made to the upcoming maintenance window.

Request a change freeze

In CMC version 3.24.0 and higher, you can request a change freeze up to one year in advance using the Maintenance dashboard. A change freeze is a suspension of maintenance for service updates during specific dates or periods in the calendar month.

To learn more, see the Splunk Cloud Platform maintenance policy and the Maintenance section in the Splunk Cloud Platform Service Details.

Requirements

Users with the sc_admin role can submit change freeze requests.

Request a change freeze

  1. In the Maintenance dashboard, select the Change freeze tab.
  2. Select Request change freeze.
  3. Acknowledge that you've reviewed the Splunk Cloud Platform maintenance policy.
  4. Enter the start date, end date, and reason for your change freeze request. Based on the dates you enter, the modal notifies you if a maintenance window is affected by the request.
  5. Select whether the change freeze applies to Splunk initiated changes only or both customer and Splunk initiated changes.
  6. Select Request.

Review change freeze requests

In the Maintenance dashboard, select the Change freeze tab to view your change freeze requests. The table displays requests made in the past 1 year.

Select a request to view its details such as scope, category, and impacted maintenance windows.

Edit change freeze request

  1. In the Maintenance dashboard, select the Change freeze tab.
  2. Select the request you want to edit.
  3. Select Edit change freeze.
  4. Edit the request.
  5. Select Update.

Delete change freeze request

  1. In the Maintenance dashboard, select the Change freeze tab.
  2. Select the request you want to delete.
  3. Select Delete change freeze.
  4. Select Delete.
Last modified on 13 May, 2024
Use the Health dashboard   Use the Alerts dashboard

This documentation applies to the following versions of Splunk Cloud Platform: 9.0.2303, 9.0.2305, 9.1.2308 (latest FedRAMP release), 9.1.2312


Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters