-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs-sample.yml
270 lines (245 loc) · 9.57 KB
/
mkdocs-sample.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# Project information
site_name: "AccuKnox"
site_description: "Zero trust Runtime Kubernetes security"
site_author: "Asif Ali"
site_url: "https://accuknox.com/"
# Copyright
copyright: "© 2021 AccuKnox. All Rights Reserved."
# Repository
repo_name: "GitHub"
repo_url: "https://github.com/accuknox/accuknox-help"
edit_uri: "https://github.com/accuknox/accuknox-help/edit/main/docs_sample"
# Configuration
docs_dir: "docs_sample"
theme:
name: null
custom_dir: !ENV [THEME_DIR, "material"]
features:
- content.code.annotate
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
palette:
- scheme: default
primary: indigo
accent: blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: blue
toggle:
icon: material/toggle-switch
name: Switch to light mode
name: "material"
language: "en"
shortcuts:
help: 191 # ?
next: 78 # n
previous: 80 # p
search: 83 # s
#font:
#text: 'Ubuntu'
#code: 'Ubuntu Mono'
#icon:
#logo: 'images/logo.svg'
favicon: 'assets/images/favicon.ico'
# Extensions
markdown_extensions:
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.snippets
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid-experimental
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
plugins:
- search:
separator: '[\s\-\.]+'
lang:
- en
# Customization
extra_javascript:
- "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js?config=TeX-MML-AM_CHTML"
extra_css:
- "assets/css/custom.css"
extra:
analytics: # provider: google
property: G-6G8J3CBYXC
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Help us improve this page by
using our <a href="..." target=_blank>feedback form</a>.
manifest: "manifest.json"
social:
- icon: "fontawesome/brands/github-alt"
link: "https://github.com/accuknox"
- icon: "fontawesome/brands/twitter"
link: "https://twitter.com/AccuKnox"
# Page tree
pages:
nav:
- "Home":
- "Overview": "getting-started/overview.md"
- "Agent Installation": "getting-started/installing-agents.md"
- "Policy Management Life Cycle": "manage_policies/manage_policies.md"
- "Cluster Management": "getting-started/cluster-management.md"
- "Workspace Manager":
- "What is Workspace Manager": "getting-started/workspace-manager.md"
- "What is Channel Integration": "getting-started/channel-integration.md"
# - "Getting started":
# - "What is Accuknox": "getting-started/what-is-accuknox.md"
- "Open Source":
- "Overview": "open-source/open-source-accuknox.md"
- "Cilium": "open-source/what-is-cilium.md"
- "Installing Cilium": "open-source/cilium-install.md"
- "KubeArmor": "open-source/what-is-kubearmor.md"
- "Installing KubeArmor": "open-source/kubearmor-install.md"
- "Policy Discovery Howto": "open-source/policy_discovery_playbook.md"
# - "Auto Discovery of Policies": "open-source/auto-policy-generation.md"
- "Accuknox Cloud":
- "Agent Installation": "getting-started/installing-agents.md"
- "Agent Metrics": "getting-started/agent-metrics.md"
- "Logs and Triggers": "getting-started/Logs.md"
- "Workspace Manager":
- "What is Workspace Manager": "getting-started/workspace-manager.md"
- "What is Channel Integration": "getting-started/channel-integration.md"
- "Integrations":
- "Slack": "getting-started/slack-integration.md"
- "Splunk": "getting-started/splunk-integration.md"
- "CloudWatch": "getting-started/cloudwatch-integration.md"
- "Elastic": "getting-started/elastic-integration.md"
- "Policy Management Life Cycle": "manage_policies/manage_policies.md"
- "Policies and Rules": "policies-and-rule/policies-and-rule.md"
- "Auto Discovered Policies": "auto_discovery_of_policies/auto_discovery_of_policies.md"
- "Data Security":
- "Overview" : "data-protection/overview.md"
- "User Personas and Use Cases" : "data-protection/user-personas-use-cases.md"
- "Types of Solutions" : "data-protection/types-of-solutions.md"
- "Currently Available Classification" : "data-protection/oltp-classification-types.md"
- "S3":
- "Introduction" : "data-protection/s3/introduction.md"
- "Requirements" : "data-protection/s3/requirements.md"
- "Setup and Configure S3 Audit" : "data-protection/s3/setup-and-configure.md"
- "Audit Reporter Installation Guide" : "data-protection/s3/s3-audit-reporter-installation-guide.md"
- "MySQL":
- "Introduction" : "data-protection/mysql/introduction.md"
- "Components Required for Installation" : "data-protection/mysql/components-for-installation.md"
- "AccuKnox Data Agent":
- "Introduction": "data-protection/mysql/data-agent/introduction.md"
- "Installation": "data-protection/mysql/data-agent/installation.md"
- "Audit Log Exporter":
- "Introduction": "data-protection/mysql/audit-log-exporter/introduction.md"
- "Installation": "data-protection/mysql/audit-log-exporter/installation.md"
- "Enterprise On Prem":
- "Support": "accuknox-onprem/support.md"
- "What is it?": "accuknox-onprem/what-is-ak-on-prem.md"
- "Accuknox Architecture":
- "Diagram": "accuknox-onprem/ak-architecture-diagram.md"
- "Purpose": "accuknox-onprem/ak-architecture-diagram-purpose.md"
- "Pre-requisites":
- "Hardware Pre-requisites": "accuknox-onprem/hw-req-pre-requisites.md"
- "Istio":
- "Purpose": "accuknox-onprem/istio-purpose.md"
- "How to install?": "accuknox-onprem/istio-install.md"
- "How to verify?": "accuknox-onprem/istio-verify.md"
- "MySQL":
- "Purpose": "accuknox-onprem/mysql-purpose.md"
- "How to install?": "accuknox-onprem/mysql-install.md"
- "How to verify?": "accuknox-onprem/mysql-verify.md"
- "Kafka":
- "Purpose": "accuknox-onprem/kafka-purpose.md"
- "How to install?": "accuknox-onprem/kafka-install.md"
- "How to verify?": "accuknox-onprem/kafka-verify.md"
- "Pinot":
- "Purpose": "accuknox-onprem/pinot-purpose.md"
- "How to install?": "accuknox-onprem/pinot-install.md"
- "How to verify?": "accuknox-onprem/pinot-verify.md"
- "Temporal":
- "Purpose": "accuknox-onprem/temporal.md"
- "How to install?": "accuknox-onprem/temporal-deploy.md"
- "S3 Data Protection":
- "Installation & Deployment Steps for Various Modules": "s3-data-protection/overview.md"
- "AccuKnox S3 Access Audit": "s3-data-protection/s3-access-audit.md"
- "S3 Data Protection Test Scenarios": "s3-data-protection/test-scenarios.md"
- "Accuknox services":
- "Hardware Pre-requisites": "accuknox-onprem/hw-req-core-components.md"
- "How to install?": "accuknox-onprem/core-components-install.md"
- "How to verify?": "accuknox-onprem/core-components-verify.md"
- "Accuknox agents":
- "Hardware Pre-requisites": "accuknox-onprem/hw-req-agent.md"
- "How to install?": "accuknox-onprem/agents-install.md"
- "How to verify?": "accuknox-onprem/agents-verify.md"
- "Monitoring":
- "Prometheus and Grafana":
- "Hardware Pre-requisites": "accuknox-onprem/hw-req-prom-graf.md"
- "Purpose": "accuknox-onprem/prom-graf-purpose.md"
- "How to install?": "accuknox-onprem/prom-graf-install.md"
- "How to verify?": "accuknox-onprem/prom-graf-verify.md"
- "Logging":
- "Hardware Pre-requisites": "accuknox-onprem/hw-req-logging.md"
- "ECK":
- "Purpose": "accuknox-onprem/eck-purpose.md"
- "How to install?": "accuknox-onprem/eck-install.md"
- "How to verify?": "accuknox-onprem/eck-verify.md"
- "Loki":
- "Purpose": "accuknox-onprem/loki-purpose.md"
- "How to install?": "accuknox-onprem/loki-install.md"
- "How to verify?": "accuknox-onprem/loki-verify.md"
- "On-prem Elastic":
- "How to install?": "accuknox-onprem/elastic-deploy.md"
- "How to verify?": "accuknox-onprem/elastic.md"
- "On-prem UI":
- "Purpose": "accuknox-onprem/ui-onprem-purpose.md"
- "How to install?": "accuknox-onprem/ui-onprem.md"