This article shows how to decide what you need, find the relevant section of the product documentation, search with terms that work, and ask for help with the details that get a fast answer.
How the documentation is organized
The product documentation has eight top-level sections. The section names describe the kind of information that each section holds, not the product. A single component, such as a Defender, appears in several sections, once for each kind of information.
Start with what you need to do
The following table maps common goals to the section that holds the answer. Find the row that matches your goal, and open that section first.
| I want to | Open this section | What you find there |
| Plan a program or prepare for onboarding | Plan & onboard | The implementation guide, discovery questionnaires, and the responsibility matrix |
| Hear about new capabilities | Latest updates | Release highlights and announcements |
| See what changed in a release | Release notes | Release notes for the Cequence Platform and for each data plane component |
| Upgrade or roll back | Release notes | Upgrade and rollback articles, filed with the release notes for the target release |
| Install the Cequence Platform or a component | Installation | Install articles, grouped by the Cequence Platform and each data plane component, then by environment such as bare metal, virtual appliance, or Kubernetes |
| Connect traffic, SSO, or an export target | Integrations | Integration guides and the matching download articles |
| Understand how a capability works | Features | API Security, Bot Management, Platform, and WAAP articles |
| Complete a specific task | How-to articles | Step-by-step articles |
| Look up an exact value or policy | References | Environment variables, data properties, threat classification, the end-of-life policy, and downloads |
Find your component
Each component has its own release number, so release notes and install articles are filed by component. The following table shows where to find both.
| Component | Install articles | Release notes |
| Cequence Platform | Installation, Cequence Platform, then your environment | Release notes, Cequence Platform, then 9.x or 8.x |
| Defender | Installation, Data Plane Components, Defender | Release notes, Data Plane Components, Defender |
| Bridge | Installation, Data Plane Components, Bridge | Release notes, Data Plane Components, Bridge |
| eBPF Sensor | Installation, Data Plane Components, eBPF Sensor | Release notes, Data Plane Components, eBPF Sensor |
| Network Sensor | Installation, Data Plane Components, Network Sensor | Release notes, Data Plane Components, Network Sensor |
| Honeytrap | Not applicable | Release notes, Data Plane Components, Honeytrap |
Find an integration
Integrations are grouped by what you connect. From the Integrations section, open the group that matches your goal.
- To send traffic to the Cequence Platform, open Integrations with Traffic Sources. The groups are CDNs, API gateways, web application firewalls, traffic mirroring, load balancers, proxies, service meshes, and ecommerce platforms.
- To mitigate bad traffic at a third-party WAF, open Integrations with 3rd Party WAFs for Mitigation.
- To sign in through your identity provider, open Integrations for Single Sign On.
- To send events to another system, open Integrations to Export Data to 3rd Party Systems. Syslog, Datadog, and Splunk have their own subsections.
- To test APIs during builds, open Integrations with CI/CD Pipelines for API Security Testing.
Many guides have a companion article with a name that ends in "downloads". The companion article holds the files that the guide references.
Search with specifics
Search matches the words on a page, so the words that you use decide the result. From the search box at the top of any page, use the following techniques.
- Paste the exact text of an error message, in quotation marks.
- Add the component name to a general term. Compare
environment variableswithDefender environment variables. - Add the release number. Titles include releases, such as
9.2.x to 9.3.x upgrade and rollback. - Start with two or three words, and add a word only when the results are too broad.
Check the release and your access
Two checks prevent most wrong-article problems.
- Before you follow an article for an older release, check the Cequence Products End-of-Life policy under References.
- Some articles are visible only to signed-in customers. When a link asks you to sign in, sign in and select the link again.
- The Latest Releases article under Release notes lists the current release of each component.
Open a ticket with these details
When the documentation does not answer your question, a ticket that includes the following details usually gets an answer without a round of follow-up questions.
- The component and release number, and the environment where the component runs.
- What you expected, and what happened instead.
- The exact error text, or a screenshot.
- The steps that you already tried.
- The articles that you read, so the team can correct an article that misled you.
To check for a known outage first, open the Cequence status page. To report your problem, create a ticket.