Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 4b587ff

Browse files
authored
Merge pull request #1816 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents 1f1913b + fca60e9 commit 4b587ff

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

gdi/get-data-in/application/php/sfx/instrumentation/instrument-php-application.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,14 +186,14 @@ The following example shows how to update a deployment to expose environment var
186186
- name: myapp
187187
image: <image-name>
188188
env:
189-
- name: SIGNALFX_PHP_LIBRARY
189+
- name: HOST_IP
190190
valueFrom:
191191
fieldRef:
192192
fieldPath: status.hostIP
193193
- name: SIGNALFX_SERVICE_NAME
194194
value: "<service-name>"
195195
- name: SIGNALFX_ENDPOINT_URL
196-
value: "http://<endpoint>:9080/v1/trace"
196+
value: "http://$(host_ip):9411/api/v2/spans"
197197
- name: SIGNALFX_TRACE_GLOBAL_TAGS
198198
value: "deployment.environment:<my_environment>"
199199

splunkplatform/unified-id/unified-identity.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,26 @@ Unified Identity: Splunk Cloud Platform and Splunk Observability Cloud
99

1010
Splunk Cloud Platform offers Unified Identity with Splunk Observability Cloud.
1111

12+
1213
What is Unified Identity?
1314
==========================================================================================
15+
1416
Unified Identity is the integration of Splunk Cloud Platform and Splunk Observability Cloud. Users can access both platforms using a single identity by logging into Splunk Observability Cloud with SSO using their Splunk Cloud Platform credentials. Splunk Cloud Platform serves as the Identity Provider (IdP). You can use a third party identity provider, such as Okta, but you will lose the benefits of the integrated experience. See :ref:`unified-identity-benefits`
1517

1618
When you integrate your Splunk Cloud Platform and Splunk Observability Cloud instances and activate Unified Identity, administrators can set up all users in a central location, Splunk Cloud Platform. Splunk Cloud Platform admins control user and data access permissions for both platforms separately in respective products. For more information, see :ref:`admin-manage-users`. To learn about user roles and permissions in Splunk Cloud Platform, see :new-page:`About configuring role-based user access <https://docs.splunk.com/Documentation/SplunkCloud/latest/Security/Aboutusersandroles>`. The integration extends permissions to access data indexed in Splunk Cloud Platform to Splunk Observability Cloud applications with no administrative overhead. See :ref:`unified-id-user-provisioning` for more information.
1719

1820

1921
Who can access Single Sign On (SSO) and the benefits of Unified Identity?
2022
==========================================================================================
23+
2124
All customers who have both Splunk Cloud Platform and Splunk Observability Cloud can access Unified Identity. Users must be on Splunk Cloud Platform version 9.x and higher. The AWS region for your Splunk Cloud Platform instance must be the same as your Splunk Observability Cloud instance realm.
2225

26+
2327
.. _unified-identity-benefits:
2428

2529
What are the benefits of Unified Identity?
2630
==========================================================================================
31+
2732
Organizations that complete the integration of Splunk Cloud Platform and Splunk Observability Cloud experience the following benefits:
2833

2934
* End users can access Splunk Observability Cloud with Single Sign On (SSO) using Splunk Cloud Platform as the Identity Provider (IdP).
@@ -39,14 +44,19 @@ Organizations that complete the integration of Splunk Cloud Platform and Splunk
3944

4045
How to set up Unified Identity
4146
==========================================================================================
47+
4248
You can pair only one Splunk Cloud Platform instance with one Splunk Observability Cloud instance at a time. Customers with multiple Splunk Observability Cloud organizations must choose one to pair with the chosen Splunk Cloud Platform instance.
4349

50+
4451
Prerequisites
4552
------------------------------------------------------------------------------------------
53+
4654
You must be an admin of the Splunk Cloud Platform and Splunk Observability Cloud instances that you want to pair.
4755

56+
4857
New Splunk Observability Cloud customers
4958
------------------------------------------------------------------------------------------
59+
5060
Splunk Cloud Platform customers who want to purchase Splunk Observability Cloud must take the following actions to set up Unified Identity:
5161

5262
1. Inform your Splunk sales representative that you want to purchase Splunk Observability Cloud or start a trial. The sales representative initiates a Splunk Observability Cloud trial that is already integrated with their Splunk Cloud Platform instance.
@@ -63,6 +73,8 @@ If you already have a Splunk Cloud Platform account and a Splunk Observability C
6373

6474
2. Obtain a user API access token (session token) from your Splunk Observability Cloud account. See :ref:`admin-api-access-tokens` to learn how.
6575

76+
.. note:: The API token must have ``admin`` privileges.
77+
6678
3. To pair orgs, open Terminal and enter the following Admin Config Services (ACS) command:
6779

6880
.. code-block:: bash
@@ -94,16 +106,20 @@ If you already have a Splunk Cloud Platform account and a Splunk Observability C
94106

95107
Users will receive an email telling them to authenticate to Splunk Observability Cloud using the new authentication method through Splunk Cloud Platform SSO. Note that users can continue to use their previous login method. If you want to force all users to authenticate through Splunk Cloud Platform SSO, reach out to Splunk Customer Support to deactivate local login. To deactivate login through a third party identity provider, go to :strong:`Data Management` in Observability Cloud, select the appropriate integration (for example, Okta), and select :strong:`Deactivate`.
96108

109+
97110
.. _unified-id-user-provisioning:
98111

99112
User provisioning
100113
==========================================================================================
114+
101115
To benefit from Unified Identity, all users must have a Splunk Cloud Platform user with the ``o11y_access`` role.
102116

117+
103118
.. _existing-scp-users:
104119

105120
Existing Splunk Cloud Platform users
106121
------------------------------------------------------------------------------------------
122+
107123
In Splunk Cloud Platform, create the custom role ``o11y_access`` and assign it to all users who you want to grant access to Splunk Observability Cloud. See :new-page:`Create and manage roles with Splunk Web <https://docs.splunk.com/Documentation/Splunk/latest/Security/Addandeditroles#Add_or_edit_a_role>` for more information on Splunk Cloud Platform roles. Follow only the instructions in the :guilabel:`Add or edit a role` section. Note that you do not need to assign the role any capabilities or indexes.
108124

109125
.. note:: If you do not create and assign the custom role ``o11y_access``, users receive the following error message when trying to log in to Observability Cloud: "You do not have access to Splunk Observability Cloud. Contact your Splunk Cloud Platform administrator for assistance."
@@ -132,12 +148,15 @@ The system defines the mapping process, and a user cannot change it at provision
132148

133149
Existing Splunk Observability Cloud users
134150
------------------------------------------------------------------------------------------
151+
135152
If an existing Observability Cloud user does not have a Splunk Cloud Platform account, create a Splunk Cloud Platform user for them and give it the ``o11y_access`` role. You do not need to assign the ``o11y_access`` role any capabilities or indexes. The user can now access Splunk Cloud Platform and can sign into Observability Cloud with SSO using their Splunk Cloud Platform credentials. Splunk Cloud Platform and Observability Cloud Log Observer respect index access assigned to the user in Splunk Cloud Platform. The Observability Cloud user retains their existing Observability Cloud role.
136153

137154
If an existing Observability Cloud user already has a Splunk Cloud Platform user, assign the ``o11y_access`` role to the user in the Splunk Cloud Platform instance.
138155

156+
139157
New users
140158
------------------------------------------------------------------------------------------
159+
141160
To add a new user to Splunk Observability Cloud after the integration is complete, a Splunk Cloud Platform administrator must do the following:
142161

143162
1. Create a new user in Splunk Cloud Platform either locally or through a third party IdP.
@@ -147,13 +166,16 @@ To add a new user to Splunk Observability Cloud after the integration is complet
147166

148167
The user can now log in to Splunk Observability Cloud with their Splunk Cloud Platform permissions.
149168

169+
150170
After initial user provisioning
151171
-------------------------------------------------------------------------------------------
172+
152173
Once users are set up, Splunk Cloud Platform admins and Splunk Observability Cloud admins must manage roles independently. After initial setup, role updates in either product platform do not impact a user's role in the other platform. However, a user's permissions to specific indexes in Splunk Cloud Platform are always controlled by a user's role and permissions in Splunk Cloud Platform.
153174

154175

155176
What to expect at first login
156177
==========================================================================================
178+
157179
The first time a user tries to log in to Splunk Observability Cloud after the integration, they are directed to their Splunk Cloud Platform login page.
158180

159181
Follow these steps at first login to Splunk Observability Cloud:
@@ -168,10 +190,12 @@ Follow these steps at first login to Splunk Observability Cloud:
168190

169191
After the first login, you do not need to provide your Splunk Cloud Platform credentials again. On subsequent logins, if you are already logged in to Splunk Cloud Platform, select :strong:`Sign in with Splunk Cloud` and you are automatically signed in to Splunk Observability Cloud.
170192

193+
171194
.. _no-access-error:
172195

173196
No access error
174197
------------------------------------------------------------------------------------------
198+
175199
Contact your Splunk Cloud Platform administrator if you receive the following :strong:`No access` error message:
176200

177201
.. image:: /_images/splunkplatform/no-access-error.png
@@ -180,30 +204,42 @@ Contact your Splunk Cloud Platform administrator if you receive the following :s
180204

181205
Users receive this error message if their Splunk Cloud Platform administrator did not give them the custom role ``o11y_access``. The ``o11y_access`` role is required to access Splunk Observability Cloud.
182206

207+
183208
Working in Splunk Observability Cloud after the integration
184209
==========================================================================================
210+
185211
In addition to logging in with SSO, users and admins experience other differences after the integration is complete.
186212

213+
187214
Point-and-click log analysis
188215
------------------------------------------------------------------------------------------
216+
189217
One important advantage of the integration is that users can now query their Splunk Cloud Platform logs in Log Observer's no-code UI. Users can create advanced queries without knowing SPL with Log Observer's filters and aggregations. See :ref:`logs-queries` for more information.
190218

219+
191220
Related Content
192221
------------------------------------------------------------------------------------------
222+
193223
Another significant benefit of the integration is that you can access any data related to your Splunk Cloud Platform logs that resides in other Splunk Observability Cloud applications, such as Infrastructure Monitoring, APM, RUM, and Synthetics. While exploring your data in any of the Splunk Observability Cloud applications, the Related Content bar always populates with links to other Splunk Observability Cloud applications that have related data. Access related metrics, traces, or infrastructure components when you observe your Splunk Cloud Platform logs in Splunk Observability Cloud.
194224

225+
195226
Unified user session
196227
------------------------------------------------------------------------------------------
228+
197229
You can navigate seamlessly back and forth between Splunk Cloud Platform and any Splunk Observability Cloud application (Infrastructure Monitoring, APM, Log Observer, RUM, and Synthetics) to see all data that your Splunk Cloud Platform role has permissions to see. Users need to log in only once to gain access to Splunk Cloud Platform and Splunk Observability Cloud. You don't need additional login to move from one platform to the other when exploring data.
198230

231+
199232
Splunk Cloud Platform maintenance windows
200233
------------------------------------------------------------------------------------------
234+
201235
During a Splunk Cloud Platform maintenance window, users cannot log in to Splunk Observability Cloud with Splunk Cloud Platform for SSO. Login can be impacted from 2 to 5 minutes during Splunk Cloud Platform maintenance windows. Users can log into Splunk Observability Cloud again as soon as the maintenance window is completed.
202236

203237
During a maintenance window, Splunk Cloud Platform displays a banner indicating the start and end time of the window. If a user is already logged in to Splunk Observability Cloud at the start of a maintenance window, the user is not impacted directly. However, access to Splunk Cloud Platform logs in Log Observer Connect are unavailable during the maintenance window. You can continue working in Splunk Observability Cloud.
204238

205239
Typically, there are two planned maintenance windows per month for a Splunk Cloud Platform instance. Customers can determine the scheduling of maintenance windows and usually set them up to occur during the customer's downtime. Talk to your Splunk Cloud Platform administrator about the planned maintenance windows.
206240

241+
207242
Changing identity providers
208243
------------------------------------------------------------------------------------------
244+
209245
If you no longer want to use Splunk Cloud Platform as your identity provider for SSO when signing in to Splunk Observability Cloud, set up a third party IdP for Splunk Observability Cloud login before you deactivate your Splunk Cloud Platform instance. Deactivating Splunk Cloud Platform only after setting up a new third party IdP ensures that your Splunk Observability Cloud users do not lose access.

0 commit comments

Comments
 (0)