Skip to content

Commit

Permalink
Merge pull request #284 from stakater/update-toc
Browse files Browse the repository at this point in the history
Update the TOC
  • Loading branch information
rasheedamir authored Jul 28, 2024
2 parents c56e588 + a9efd78 commit 7615281
Show file tree
Hide file tree
Showing 22 changed files with 68 additions and 59 deletions.
2 changes: 1 addition & 1 deletion content/for-cisos/backup-restore/restore-with-gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ oc scale statefulsets <NAME> --replicas 0
Delete the PVC which you want to restore data so that its created again by Velero.

```sh
oc delete pvc <PVC-NAME> -n <NAMESPACE>
oc delete pvc <PVC-NAME> -n <NAMESPACE>
```

## 5. Restore Velero Backup
Expand Down
16 changes: 8 additions & 8 deletions content/for-cisos/backup-restore/stateful-app-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,26 @@ apiVersion: v1
allowHostPorts: true
allowedCapabilities:
- '*'
defaultAddCapabilities: []
fsGroup:
defaultAddCapabilities: []
fsGroup:
type: RunAsAny
groups:
groups:
- system:cluster-admins
- system:nodes
metadata:
name: privileged-app-test
priority: null
readOnlyRootFilesystem: false
requiredDropCapabilities: []
runAsUser:
requiredDropCapabilities: []
runAsUser:
type: RunAsAny
seLinuxContext:
seLinuxContext:
type: RunAsAny
seccompProfiles:
- '*'
supplementalGroups:
supplementalGroups:
type: RunAsAny
users:
users:
- system:serviceaccount:cassandra-app:default
volumes:
- '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,17 +98,17 @@ Login to Vault to view <your-tenant> path.
<div style="text-align:center"><img src="images/git-pat-creds.png" /></div>

### Adding External Secret

Since we want the `git-pat-creds` secret to be deployed in all of the tenant namespaces, we will use a multi-tenant-operator template to deploy it.

1. Open up the `infra-gitops-config` repository that we have already bootstrapped.

1. Open the `tenant-operator-config` folder and create a `templates` folder inside it.

<div style="text-align:center"><img src="images/template.png" /></div>

1. Now create a file named `git-pat-creds-template.yaml` and add the following content.

```yaml
apiVersion: tenantoperator.stakater.com/v1alpha1
kind: Template
Expand All @@ -132,9 +132,9 @@ Login to Vault to view <your-tenant> path.
target:
name: git-pat-creds
```
1. Create another file named `git-pat-creds-tgi.yaml` and add the below content.

```yaml
apiVersion: tenantoperator.stakater.com/v1alpha1
kind: TemplateGroupInstance
Expand All @@ -149,7 +149,7 @@ Login to Vault to view <your-tenant> path.
values: [ build, pr ]
sync: true
```

1. Lets see our Template and TGI in ArgoCD. Open up ArgoCD and look for `tenant-operator-config` application. You should be able to see your Template and TGI deployed.

<div style="text-align:center"><img src="images/tgi-and-template.png" /></div>
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ This chart will generate deployment, service account and service custom resource
helm.sh/chart: application-2.1.13
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/part-of: APP_NAME
spec:
spec:
type: "ClusterIP"
selector:
app.kubernetes.io/name: APP_NAME
Expand All @@ -124,7 +124,7 @@ This chart will generate deployment, service account and service custom resource
helm.sh/chart: application-2.1.13
app.kubernetes.io/managed-by: Helm
app.kubernetes.io/part-of: APP_NAME
annotations:
annotations:
reloader.stakater.com/auto: "true"
name: APP_NAME
namespace: default
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ In this guide we will deploy an application with tilt and namespace in remote Op
cd deploy
# Helm credentials can be found in Vault or in a secret in build namespace
helm repo add stakater-nexus <private repo URL> --username helm-user-name --password ********;
helm repo add stakater-nexus <private repo URL> --username helm-user-name --password ********;
cd ..
```
Expand Down Expand Up @@ -143,7 +143,7 @@ In this guide we will deploy an application with tilt and namespace in remote Op

```yaml
application:
deployment:
imagePullSecrets: null
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The webhook setup acts as a bridge between your code repository and the CI/CD pi
1. You will be brought to the `Vault` console. You should see the key/value path for <your-tenant>.
<div style="text-align:center"><img src="images/vault-tenant.png" /></div>
1. Click on `<your-tenant>/kv/`.
1. You will now be brought to the `secrets` and the `configurations` in Vault for <your-tenant>. Click on `create secret`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
annotations:
pipelinesascode.tekton.dev/on-event: "[pull_request]" # Trigger the pipelineRun on pullrequest events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml]"
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml]"
pipelinesascode.tekton.dev/max-keep-runs: "2" # Only remain 2 latest pipelineRuns on SAAP
spec:
params:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ The create environment task utilizes [Tronador](https://docs.stakater.com/tronad
annotations:
pipelinesascode.tekton.dev/on-event: "[push]" # Trigger the pipelineRun on push events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml]"
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml]"
pipelinesascode.tekton.dev/max-keep-runs: "2" # Only remain 2 latest pipelineRuns on SAAP
spec:
params:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
annotations:
pipelinesascode.tekton.dev/on-event: "[pull_request]" # Trigger the pipelineRun on pullrequest events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/code-linting-mvn/0.0.4/task/stakater-code-linting/stakater-code-linting.yaml]"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
annotations:
pipelinesascode.tekton.dev/on-event: "[pull_request]" # Trigger the pipelineRun on push events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/code-linting-mvn/0.0.4/task/stakater-code-linting/stakater-code-linting.yaml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
annotations:
pipelinesascode.tekton.dev/on-event: "[pull_request]" # Trigger the pipelineRun on push events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/code-linting-mvn/0.0.4/task/stakater-code-linting/stakater-code-linting.yaml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
annotations:
pipelinesascode.tekton.dev/on-event: "[pull_request]" # Trigger the pipelineRun on push events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/code-linting-mvn/0.0.4/task/stakater-code-linting/stakater-code-linting.yaml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
annotations:
pipelinesascode.tekton.dev/on-event: "[pull_request]" # Trigger the pipelineRun on push events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/code-linting-mvn/0.0.4/task/stakater-code-linting/stakater-code-linting.yaml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
annotations:
pipelinesascode.tekton.dev/on-event: "[pull_request]" # Trigger the pipelineRun on push events on branch main
pipelinesascode.tekton.dev/on-target-branch: "main"
pipelinesascode.tekton.dev/task: "[git-clone,
pipelinesascode.tekton.dev/task: "[git-clone,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/code-linting-mvn/0.0.4/task/stakater-code-linting/stakater-code-linting.yaml,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You have already created a PipelineRun in the previous tutorial. Let's now add a
https://raw.githubusercontent.com/stakater-tekton-catalog/rox-image-check/0.0.7/task/stakater-rox-image-check/stakater-rox-image-check.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/rox-deployment-check/0.0.4/task/stakater-rox-deployment-check/stakater-rox-deployment-check.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/checkov-scan/0.0.4/task/stakater-checkov-scan/stakater-checkov-scan.yaml,
https://raw.githubusercontent.com/stakater-tekton-catalog/helm-push/0.0.17/task/stakater-helm-push/stakater-helm-push.yaml]"
https://raw.githubusercontent.com/stakater-tekton-catalog/helm-push/0.0.17/task/stakater-helm-push/stakater-helm-push.yaml]"
pipelinesascode.tekton.dev/max-keep-runs: "2" # Only remain 2 latest pipelineRuns on SAAP
spec:
params:
Expand Down
4 changes: 2 additions & 2 deletions content/legal-documents/agreement.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
Between

Stakater AB, David Bagares gata 26A, 111 38 Stockholm, Sweden

(Hereinafter referred to as "STAKATER")

and

[CUSTOMER NAME & ADDRESS]

(Hereinafter referred to as "CUSTOMER")

Each individually a "**Party**" and together the "**Parties**"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,19 +70,19 @@ forecastle:
# Add additional labels on Forecastle Custom Resource
additionalLabels:
# URL of the icon for the custom app
icon: https://raw.githubusercontent.com/stakater/ForecastleIcons/master/stakater-big.png
# Name of the application to be displayed on the Forecastle Dashboard
displayName: "application"
# Group for the custom app (default: .Release.Namespace)
group: ""
# Add properties to Custom Resource
properties:
# Whether app is network restricted or not
networkRestricted: false
```
Expand Down
4 changes: 2 additions & 2 deletions content/managed-addons/monitoring-stack/grafana-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,10 @@ grafanaDashboard:
enabled: true
additionalLabels:
test-label: chart
annotations:
annotations:
test-annoation: chart
contents:
dashboard-test-name-1:
dashboard-test-name-1:
json: |-
{
...
Expand Down
2 changes: 1 addition & 1 deletion content/managed-addons/monitoring-stack/log-alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Following Configuration will send the log to Slack channel `#my-application-log-
deployment:
fluentdConfigAnnotations:
notifications:
slack:
slack:
webhookURL: "https://hooks.slack.com/services/XXXXXXX/YYYYYYYYY/aaaaaaabbbbbcccccddd"
channelName: "#my-application-log-alerts"
key: "level"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ alertmanagerConfig:
receivers:
- name: 'slack-webhook'
slackConfigs:
- apiURL:
- apiURL:
name: slack-webhook-config
key: webhook-url
channel: '#channel-name'
Expand Down Expand Up @@ -119,7 +119,7 @@ A sample PrometheusRule can be configured in [Application Chart](https://github.
```yaml
prometheusRule:
enabled: true
groups: []
groups: []
- name: example-app-uptime
rules:
- alert: ExampleAppDown
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@
![Administration Console](./images/keycloak-1.png)

- Select Administration Console. Login credentials are present in secret `rhsso-creds` (previously called `auth-secrets`) in `stakater-auth` namespace

![Login Admin Console](./images/keycloak-2.png)

- Click on `Users` from left panel and click on `view all users button`. Select the user you want to assign admin role to.

![Users](./images/keycloak-3.png)

- On Role Mappings screen , select `nexus3` in client roles drop down.

![Role Mappings](./images/keycloak-4.png)

- On user screen select Role Mappings tab , `nexus-oauth-admin` role will be present in left most column , select it and click on `Add selected`

![nexus OAuth admin Role](./images/keycloak-5.png)

- Role is assigned to user

![add selected role](./images/keycloak-6.png)\

- Now login to nexus repository you will have admin access

![Nexus Repository](./images/keycloak-7.png)
23 changes: 16 additions & 7 deletions theme_override/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,24 @@ nav:
- about/responsibilities.md
- Cloud Providers:
- about/cloud-providers/overview.md
- about/cloud-providers/stakater-cloud.md
- about/cloud-providers/stakater-cloud.md
- about/cloud-providers/ai-sweden-labs.md
- about/cloud-providers/aws.md
- about/cloud-providers/azure.md
- about/cloud-providers/gcp.md
- about/cloud-providers/elastx.md
- about/cloud-providers/cleura.md
- about/cloud-providers/binero.md
- about/cloud-providers/bring-your-own-cloud.md
- about/cloud-providers/cleura.md
- about/cloud-providers/complior.md
- about/cloud-providers/elastx.md
- about/cloud-providers/epm.md
- about/cloud-providers/exoscale.md
- about/cloud-providers/upcloud.md
- about/cloud-providers/fuga-cloud.md
- about/cloud-providers/gcp.md
- about/cloud-providers/ict.md
- about/cloud-providers/ovhcloud.md
- about/cloud-providers/qcloud.md
- about/cloud-providers/safespring.md
- about/cloud-providers/upcloud.md
- about/update-lifecycle.md
- about/onboarding.md
- For Administrators:
Expand Down Expand Up @@ -289,9 +298,9 @@ nav:
- Crossplane:
- managed-addons/crossplane/overview.md
- Descheduler:
- managed-addons/descheduler/overview.md
- managed-addons/descheduler/overview.md
- OpenSCAP:
- managed-addons/compliance-operator/overview.md
- managed-addons/compliance-operator/overview.md
- Legal Documents:
- legal-documents/gtc.md
- legal-documents/sla.md
Expand Down

0 comments on commit 7615281

Please sign in to comment.