Skip to content

Commit

Permalink
[8.15] [DOCS][API] Adds Crowdstrike connector config and secrets; edi…
Browse files Browse the repository at this point in the history
…ts UI text (#192526) (#192651)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[DOCS][API] Adds Crowdstrike connector config and secrets; edits UI
text (#192526)](#192526)

NOTE: There are more files in this backport than in the original because
we are not using the automated OpenAPI output for connector APIs in this
branch.

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-11T22:02:26Z","message":"[DOCS][API]
Adds Crowdstrike connector config and secrets; edits UI text
(#192526)","sha":"0ce33f842df3e63d971af553e16e68da75a20bc0","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorTypes","v8.16.0","v8.15.2"],"number":192526,"url":"https://github.com/elastic/kibana/pull/192526","mergeCommit":{"message":"[DOCS][API]
Adds Crowdstrike connector config and secrets; edits UI text
(#192526)","sha":"0ce33f842df3e63d971af553e16e68da75a20bc0"}},"sourceBranch":"main","suggestedTargetBranches":["8.15"],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/192526","number":192526,"mergeCommit":{"message":"[DOCS][API]
Adds Crowdstrike connector config and secrets; edits UI text
(#192526)","sha":"0ce33f842df3e63d971af553e16e68da75a20bc0"}},{"branch":"8.15","label":"v8.15.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
  • Loading branch information
lcawl authored Sep 12, 2024
1 parent 6196bd3 commit dc26350
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 10 deletions.
7 changes: 3 additions & 4 deletions docs/management/connectors/action-types/crowdstrike.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The CrowdStrike connector communicates with CrowdStrike Management Console via R
You can create connectors in *{stack-manage-app} > {connectors-ui}*. For example:

[role="screenshot"]
image::management/connectors/images/crowdstrike-connector.png[Crowdstrike connector]
image::management/connectors/images/crowdstrike-connector.png[CrowdStrike connector]
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

[float]
Expand All @@ -29,9 +29,8 @@ image::management/connectors/images/crowdstrike-connector.png[Crowdstrike connec
CrowdStrike connectors have the following configuration properties:

CrowdStrike API URL:: The CrowdStrike tenant URL. If you are using the <<action-settings,`xpack.actions.allowedHosts`>> setting, make sure the hostname is added to the allowed hosts.
CrowdStrike Client ID:: A CrowdStrike API client ID.
Client Secret:: A CrowdStrike API client secret created by the user.

CrowdStrike client ID:: The CrowdStrike API client identifier.
Client secret:: The CrowdStrike API client secret to authenticate the client ID.

[float]
[[crowdstrike-action-parameters]]
Expand Down
Binary file modified docs/management/connectors/images/crowdstrike-connector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
title: Connector request config properties for a Crowdstrike connector
required:
- url
description: Defines config properties for connectors when type is `.crowdstrike`.
type: object
properties:
url:
description: >
The CrowdStrike tenant URL.
If you are using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Connector secrets properties for a Crowdstrike connector
description: Defines secrets for connectors when type is `.crowdstrike`.
type: object
required:
- clientId
- clientSecret
properties:
clientId:
description: The CrowdStrike API client identifier.
type: string
clientSecret:
description: The CrowdStrike API client secret to authenticate the `clientId`.
type: string
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ export const URL_LABEL = i18n.translate(
export const CLIENT_ID_LABEL = i18n.translate(
'xpack.stackConnectors.security.crowdstrike.config.clientIdTextFieldLabel',
{
defaultMessage: 'Crowdstrike Client ID',
defaultMessage: 'Crowdstrike client ID',
}
);

export const CLIENT_SECRET_LABEL = i18n.translate(
'xpack.stackConnectors.security.crowdstrike.config.clientSecretTextFieldLabel',
{
defaultMessage: 'Client Secret',
defaultMessage: 'Client secret',
}
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
const actions = getService('actions');
const kibanaServer = getService('kibanaServer');
const testSubjects = getService('testSubjects');
const toasts = getService('toasts');
// const toasts = getService('toasts');
let simulatorUrl: string;
let editSimulatorUrl: string;

Expand All @@ -44,9 +44,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
await testSubjects.setValue('secrets.clientId-input', 'test');
await testSubjects.setValue('secrets.clientSecret-input', 'secret');
await commonScreenshots.takeScreenshot('crowdstrike-connector', screenshotDirectories);
await testSubjects.click('create-connector-flyout-save-test-btn');
await toasts.dismissAll();
await commonScreenshots.takeScreenshot('crowdstrike-params-test', screenshotDirectories);
// You cannot test the CrowdStrike connector
// await testSubjects.click('create-connector-flyout-save-test-btn');
// await toasts.dismissAll();
// await commonScreenshots.takeScreenshot('crowdstrike-params-test', screenshotDirectories);
await testSubjects.click('euiFlyoutCloseButton');
});
});
Expand Down

0 comments on commit dc26350

Please sign in to comment.