Skip to content

Commit

Permalink
chore: doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
moshloop committed Oct 29, 2024
1 parent 128c57d commit 6c32f60
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 46 deletions.
1 change: 1 addition & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"MD033": false,
"MD004": false,
"MD045": false,
"MD046": false,
"MD013": false,
"MD012": false,
"MD024": false,
Expand Down
53 changes: 23 additions & 30 deletions mission-control/docs/installation/saas/kubectl.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,38 +14,31 @@ The access token provided has role-based permissions limited to either [mission-
For production environments, it is recommended to use GitOps tools like Argo CD or Flux to manage configurations rather than applying them directly with kubectl. Use the kubeconfig file to configure your GitOps tool to target the Mission Control SaaS instance.
:::



1. Save the kubeconfig to your GitOps cluster:

```shell
kubectl create secret generic mission-control-kubeconfig \
-n flux-system \
--from-file=KUBECONFIG=./kubeconfig
```

```shell
kubectl create secret generic mission-control-kubeconfig \
-n flux-system \
--from-file=KUBECONFIG=./kubeconfig
```

1. Reference the kubeconfig when deploying Mission Control manifests:

```yaml
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
name: mission-control-config
namespace: flux-system
spec:
interval: 10m
path: ./
prune: true
sourceRef:
kind: GitRepository
name: mission-control-gitops
kubeConfig:
secretRef:
name: mission-control-kubeconfig
key: KUBECONFIG
```




```yaml
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
name: mission-control-config
namespace: flux-system
spec:
interval: 10m
path: ./
prune: true
sourceRef:
kind: GitRepository
name: mission-control-gitops
kubeConfig:
secretRef:
name: mission-control-kubeconfig
key: KUBECONFIG
```
Original file line number Diff line number Diff line change
Expand Up @@ -91,23 +91,26 @@ To install and run Mission Control you need the following:

An SMTP server is required for sending notifications, approvals, user invites and password resets.

The format of `connection_uri` is `smtp://hostname:port`
The format of `connection_uri` is `smtp|smtps://USER:PASS@host:PORT`

This URI will be used to connect to the SMTP server. Use the scheme `smtps` for implicit TLS sessions or `smtp` for explicit StartTLS/cleartext sessions. Nnote that TLS is always enforced with certificate trust verification by default for security reasons on both schemes. With the `smtp` scheme you can use the query parameter (`?disable_starttls=true`) to allow cleartext sessions or (`?disable_starttls=false`) to enforce StartTLS (default behaviour). Additionally, use the query parameter to allow (`?skip_ssl_verify=true`) or disallow (`?skip_ssl_verify=false`) self-signed TLS certificates (default behaviour) on both implicit and explicit TLS sessions.

Check warning on line 96 in mission-control/docs/installation/self-hosted/getting-started.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/installation/self-hosted/getting-started.mdx#L96

[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.
Raw output
{"message": "[Flanksource.FutureTense] Use present tense verbs, not future tense verbs like 'will'. Say '(event) happens' instead of '(event) will happen'.", "location": {"path": "mission-control/docs/installation/self-hosted/getting-started.mdx", "range": {"start": {"line": 96, "column": 10}}}, "severity": "WARNING"}

Check failure on line 96 in mission-control/docs/installation/self-hosted/getting-started.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/installation/self-hosted/getting-started.mdx#L96

[Flanksource.Spelling] Is 'cleartext' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'cleartext' spelled correctly? Is it missing code formatting?", "location": {"path": "mission-control/docs/installation/self-hosted/getting-started.mdx", "range": {"start": {"line": 96, "column": 135}}}, "severity": "ERROR"}

Check failure on line 96 in mission-control/docs/installation/self-hosted/getting-started.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/installation/self-hosted/getting-started.mdx#L96

[Flanksource.Spelling] Is 'Nnote' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'Nnote' spelled correctly? Is it missing code formatting?", "location": {"path": "mission-control/docs/installation/self-hosted/getting-started.mdx", "range": {"start": {"line": 96, "column": 155}}}, "severity": "ERROR"}


```yaml title="values.yaml"
kratos:
kratos:
config:
courier:
smtp:
connection_uri: # smtp://localhost:25
connection_uri: # smtp://user:pass@localhost:25
from_address: noreply@
from_name: Mission Control
# These headers will be passed in the SMTP conversation
# e.g. when using the AWS SES SMTP interface for cross-account sending.
headers: {}
# Identifier used in the SMTP HELO/EHLO command.
# Some SMTP relays require a unique identifier.
local_name:
local_name: ""
```
See also [HTTP Webhooks](https://www.ory.sh/docs/kratos/self-hosted/email-http) for sending emails.
Expand Down
28 changes: 16 additions & 12 deletions mission-control/docs/reference/canary-checker/image-variants.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,31 @@ Canary checker comes with 2 image variants:

- [arkade](https://github.com/alexellis/arkade)
- kubectl
- stern
- [stern](https://github.com/stern/stern)
- [fblog](https://github.com/brocode/fblog)

Check failure on line 12 in mission-control/docs/reference/canary-checker/image-variants.md

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/reference/canary-checker/image-variants.md#L12

[Flanksource.Spelling] Is 'fblog' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'fblog' spelled correctly? Is it missing code formatting?", "location": {"path": "mission-control/docs/reference/canary-checker/image-variants.md", "range": {"start": {"line": 12, "column": 4}}}, "severity": "ERROR"}
- jq
- yq
- [sops](https://github.com//mozilla/sops)
- PowerShell 7
- powershell-yaml
- python3
- [azure-cli](https://learn.microsoft.com/en-us/cli/azure/)
- [gcloud-cli](https://cloud.google.com/sdk/gcloud)
- kubectl-oidc
- gke-gcloud-auth-plugin
- [aws-cli](https://aws.amazon.com/cli/)

## [Full](https://github.com/flanksource/canary-checker/blob/master/build/full/Dockerfile)

- [arkade](https://github.com/alexellis/arkade)
- kubectl
- stern
- jq
- yq
- [gcloud-cli](https://cloud.google.com/sdk/gcloud)
- [aws-cli](https://aws.amazon.com/cli/)
- [azure-cli](https://learn.microsoft.com/en-us/cli/azure/)
- [dsq](https://github.com/multiprocessio/dsq)
Everthing in the minimal image plus:

Check failure on line 27 in mission-control/docs/reference/canary-checker/image-variants.md

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/reference/canary-checker/image-variants.md#L27

[Flanksource.Spelling] Is 'Everthing' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'Everthing' spelled correctly? Is it missing code formatting?", "location": {"path": "mission-control/docs/reference/canary-checker/image-variants.md", "range": {"start": {"line": 27, "column": 1}}}, "severity": "ERROR"}

- [k6](https://github.com/grafana/k6)
- java-11
- [jmeter](https://jmeter.apache.org/)
- OpenJDK Temurin 21

Check failure on line 30 in mission-control/docs/reference/canary-checker/image-variants.md

View workflow job for this annotation

GitHub Actions / vale

[vale] mission-control/docs/reference/canary-checker/image-variants.md#L30

[Flanksource.Spelling] Is 'Temurin' spelled correctly? Is it missing code formatting?
Raw output
{"message": "[Flanksource.Spelling] Is 'Temurin' spelled correctly? Is it missing code formatting?", "location": {"path": "mission-control/docs/reference/canary-checker/image-variants.md", "range": {"start": {"line": 30, "column": 11}}}, "severity": "ERROR"}
- [JMeter](https://jmeter.apache.org/)
- [Robot Framework](https://robotframework.org/)
- [benthos](https://benthos.dev)
- [dsq](https://github.com/multiprocessio/dsq)
- [restic](https://restic.net/)

You can choose which variant to use in the helm chart using:

Expand Down
2 changes: 1 addition & 1 deletion mission-control/docs/reference/connections/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ spec:
valueFrom:
secretKeyRef:
name: secret-name
key: pay
key: pat
```

:::tip Classic PAT
Expand Down

0 comments on commit 6c32f60

Please sign in to comment.