Skip to content

Commit 7d3eb1f

Browse files
authored
Merge pull request #3357 from cnvergence/add-authn-docs
🐛 fix: mermaid mkdocs error and add make target to run mkdocs locally
2 parents e4f61b1 + 50b5b37 commit 7d3eb1f

File tree

4 files changed

+17
-11
lines changed

4 files changed

+17
-11
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,5 @@ dex/
4545
*.crt
4646
*.key
4747
*.pem
48+
49+
index.html

Makefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,11 @@ generate-api-docs: ## Generate api docs
170170
VENVDIR=$(abspath docs/venv)
171171
REQUIREMENTS_TXT=docs/requirements.txt
172172

173+
.PHONY: local-docs
174+
local-docs: venv ## Run mkdocs serve
175+
. $(VENV)/activate; \
176+
VENV=$(VENV) cd docs && mkdocs serve
177+
173178
.PHONY: serve-docs
174179
serve-docs: venv ## Serve docs
175180
. $(VENV)/activate; \

docs/content/concepts/authentication/index.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,16 @@ You can configure them with the settings from Kubernetes control plane [strategi
2929
### Authentication Flow With Client Certificate
3030

3131
```mermaid
32-
flowchart
33-
n1@{ label: "Rectangle" }
34-
n1["A client sends a request
35-
with a client certificate."] --- n2
36-
n2["The proxy verifies the
37-
certificate against a trusted CA."] --- n3
38-
n3["Filters specified
39-
groups from requests."] --- n4
40-
n4["Extracts the user and
32+
flowchart TD
33+
n1["A client sends a request
34+
with a client certificate."] --> n2
35+
n2["The proxy verifies the
36+
certificate against a trusted CA."] --> n3
37+
n3["Filters specified
38+
groups from requests."] --> n4
39+
n4["Extracts the user and
4140
groups and passing them
42-
as HTTP access headers."] --- n5["Forwards the request
41+
as HTTP access headers."] --> n5["Forwards the request
4342
to the kcp API server."]
4443
```
4544

docs/content/concepts/authentication/oidc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ You can also set:
4444
## Configure kcp OIDC Authentication Using Structured Authentication Configuration
4545

4646
Alternatively, you can use the beta feature of authentication configuration from a file and set up the kcp server with it.
47-
Please note that iff you specify --authentication-config along with any of the --oidc-* command line arguments, this will be treated as a misconfiguration.
47+
Please note that if you specify `--authentication-config` along with any of the `--oidc-*` command line arguments, this will be treated as a misconfiguration.
4848

4949
```bash
5050
apiVersion: apiserver.config.k8s.io/v1beta1

0 commit comments

Comments
 (0)