Skip to content

Commit

Permalink
Merge pull request #328 from stakater/few-fixes
Browse files Browse the repository at this point in the history
update SD and remove invalid faqs
  • Loading branch information
rasheedamir authored Oct 26, 2024
2 parents d01c58f + cd2621b commit 61811da
Show file tree
Hide file tree
Showing 15 changed files with 25 additions and 256 deletions.
32 changes: 21 additions & 11 deletions content/about/service-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,14 +122,18 @@ In addition to normal users, Stakater provides access to a SAAP-specific group c

As an administrator of SAAP, you have access to the cluster-admin role. While logged in to an account with the cluster-admin role, users have mostly unrestricted access to control and configure the cluster.

### RHACS

SAAP includes Red Hat Advanced Cluster Security (RHACS) for robust security management. It ensures comprehensive build and runtime security for applications. RHACS is essential for maintaining a secure Kubernetes environment.

### Cert-Manager

SAAP comes integrated with Cert-Manager to automate the management and renewal of SSL/TLS certificates. It ensures secure communication for your applications by handling certificate issuance and renewal seamlessly.

## Red Hat Advanced Cluster Security (RHACS)

SAAP offers Red Hat Advanced Cluster Security (RHACS) as an optional, managed addon, available for an **additional fee**. RHACS enhances security by providing:

- **Visibility**: Gain insights into cluster configurations, workload vulnerabilities, and container security risks.
- **Compliance**: Monitor compliance status, address regulatory requirements, and report on Kubernetes security standards.
- **Threat Detection**: Identify potential threats and unusual activities in real-time, leveraging automated responses for faster mitigation.

## Secrets Management Stack

### Secrets Stores
Expand All @@ -140,7 +144,13 @@ SAAP includes HashiCorp Vault OSS for secrets management, limited to use by appl

#### Clouds Secrets Store

SAAP includes the External Secrets Operator (ESO) integrated with Vault OSS out of the box. If customers prefer a different secret store, ESO can be configured to connect with it. For assistance, open a [support ticket](https://support.stakater.com/index.html).
SAAP supports integration with multiple cloud provider secret stores (e.g., AWS Secrets Manager, Azure Key Vault, Google Cloud Secret Manager). Through the External Secrets Operator (ESO), SAAP seamlessly connects to these cloud secrets stores, enabling users to manage secrets stored externally within their Kubernetes clusters.

### Secret Retrieval in Clusters

#### External Secrets Operator (ESO)

The [External Secrets Operator (ESO)](https://github.com/external-secrets/external-secrets) is included in SAAP to manage secret retrieval from both HashiCorp Vault OSS and supported cloud secret stores. ESO automates secret synchronization into clusters, ensuring secrets are securely available to applications as Kubernetes-native resources.

## Networking

Expand Down Expand Up @@ -192,7 +202,7 @@ SAAP includes the OpenShift Router, the most advanced Kubernetes ingress control

### ExternalDNS

SAAP integrates with ExternalDNS, automating DNS record management for Kubernetes services. This ensures seamless DNS updates as services are created or modified within the cluster, enhancing reliability and reducing manual DNS configuration efforts.
SAAP integrates with [ExternalDNS](https://github.com/kubernetes-sigs/external-dns), automating DNS record management for Kubernetes services. This ensures seamless DNS updates as services are created or modified within the cluster, enhancing reliability and reducing manual DNS configuration efforts.

## Monitoring Stack

Expand All @@ -204,7 +214,7 @@ SAAP come with an integrated Prometheus/Grafana stack for cluster monitoring inc

SAAP provides an integrated application monitoring stack based on Prometheus/Grafana stack to monitor business applications. This allows for adding scrape targets in user namespaces.

### Metrics Data Retention
### Metrics Retention

Data is stored for 14 days only. If you need to store data for a longer period, please forward it to another system. For assistance, open a [support ticket](https://support.stakater.com/index.html).

Expand Down Expand Up @@ -234,11 +244,11 @@ SAAP deploys with services for maintaining the health and performance of the clu

SAAP offers an integrated logging stack utilizing Vector as the collector and Loki as the log store. Application logs sent to `STDOUT` are gathered by the log collector and forwarded to the log store via the cluster logging stack.

### Data Retention
### Logs Retention

Retention is set to seven days, with a limit of 200 GiB of logs per shard. For longer-term retention, customers should use the sidecar container design in their deployments and forward logs to their preferred log aggregation or analytics service. This integrated logging stack is intended for short-term retention to aid in cluster and application troubleshooting, not for long-term log archiving. For assistance, open a [support ticket](https://support.stakater.com/index.html).

### Log Forwarding
### Logs Forwarding

SAAP also supports integrating and forwarding logs to your existing monitoring system. For a list of supported logging systems, contact our support team [here](https://support.stakater.com/index.html).

Expand Down Expand Up @@ -278,7 +288,7 @@ SAAP integrates with SonarQube for robust code quality analysis and security sca

### Feature/Pull Request Environments - Tronador

SAAP includes Stakater Tronador, a powerful tool that deploys applications in dynamic ephemeral environments upon pull requests. This ensures seamless testing and validation in isolated environments. Once changes are merged, Tronador automatically cleans up, maintaining an efficient and clutter-free workspace. This integration significantly enhances the development workflow by providing reliable and automated environment management.
SAAP includes Stakater [Tronador](https://docs.stakater.com/tronador/), a powerful tool that deploys applications in dynamic ephemeral environments upon pull requests. This ensures seamless testing and validation in isolated environments. Once changes are merged, Tronador automatically cleans up, maintaining an efficient and clutter-free workspace. This integration significantly enhances the development workflow by providing reliable and automated environment management.

### Renovate

Expand Down Expand Up @@ -306,7 +316,7 @@ SAAP includes Velero (OADP) for application and volume backup and restore. Users

## In-Cluster Multi Tenancy - Stakater MTO

SAAP comes integrated with Stakater MTO (Multi-Tenant Operator), the world’s leading in-cluster Kubernetes multi-tenancy solution. This allows organizations to easily share a cluster among multiple teams.
SAAP comes integrated with [Stakater MTO (Multi-Tenant Operator)](https://docs.stakater.com/mto/latest/), the world’s leading in-cluster Kubernetes multi-tenancy solution. This allows organizations to easily share a cluster among multiple teams.

## Service Mesh

Expand Down
Empty file removed content/help/faqs/.gitkeep
Empty file.
21 changes: 0 additions & 21 deletions content/help/faqs/customization.md

This file was deleted.

28 changes: 0 additions & 28 deletions content/help/faqs/developers.md

This file was deleted.

45 changes: 0 additions & 45 deletions content/help/faqs/operations.md

This file was deleted.

21 changes: 0 additions & 21 deletions content/help/faqs/product.md

This file was deleted.

25 changes: 0 additions & 25 deletions content/help/faqs/purchasing.md

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 0 additions & 2 deletions content/managed-addons/logging-stack/images/logging.xml

This file was deleted.

13 changes: 0 additions & 13 deletions content/managed-addons/logging-stack/kibana-view-logs.md

This file was deleted.

85 changes: 3 additions & 82 deletions content/managed-addons/logging-stack/overview.md
Original file line number Diff line number Diff line change
@@ -1,89 +1,10 @@
# Logging

Stakater App Agility Platform uses EFK Stack (ElasticSearch, Fluentd and Kibana) to provide logging for applications. Fluentd daemonsets pick up the logs and send these to ElasticSearch. Kibana dashboards can be used to view/analyze logs

![Logging](./images/logging.jpg)
Stakater App Agility Platform (SAAP) uses Loki and Vector to provide logging for applications.

## Components

Here are the logging stack components:

- Fluentd
- ElasticSearch
- Kibana
- Event Router

## Parse JSON Application Logs

Logs are parsed by default if applications output logs in `JSON format` on stdout. Moreover one step nested JSON parsing is also supported additionally.

Consider the following example of a one line event by a java application:

```json
{"timestamp":"2021-04-15 11:41:01.427","level":"WARN","thread":"http-nio-8080-exec-4","mdc":{"breadcrumbId":"441ce707-8096-4aba-a927-0afa8c34802b-by-BOKE","user":"service-account-boke"},"logger":"org.zalando.logbook.Logbook","message":"{\"origin\":\"local\",\"type\":\"response\",\"correlation\":\"ef4f3737f2bcf856\"}"}
```

This will be parsed as follows:

```json
{
"timestamp":"2021-04-15 11:41:01.427",
"level":"WARN",
"thread":"http-nio-8080-exec-4",
"mdc.breadcrumbId":"441ce707-8096-4aba-a927-0afa8c34802b-by-BOKE",
"mdc.user":"service-account-boke",
"logger":"org.zalando.logbook.Logbook",
"message":"{\"origin\":\"local\",\"type\":\"response\",\"correlation\":\"ef4f3737f2bcf856\"}",
"origin": "local",
"type": "response",
"correlation": "ef4f3737f2bcf856"
}
```

## Parse non JSON Application Logs

Parsing application logs which are not in `JSON format` can be done as follows:

Consider the following example of a one line event by a java application:

```sh
2019-11-27 11:04:12.682 INFO 1 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet : Initializing Servlet 'dispatcherServlet'
```

The configuration to parse/match/send logs can be specified in the [Application Chart](https://github.com/stakater-charts/application), by specifying regular expressions as described below:

| Parameter | Description |
|:---|:---|
|.Values.deployment.fluentdConfigAnnotations.regexFirstLine|specify the regex to match the first line of the log|
|.Values.deployment.fluentdConfigAnnotations.regex|specify the regex to parse the complete log entry|
|.Values.deployment.fluentdConfigAnnotations.timeFormat|specify the regex to parse time|

Use the following Configuration for parsing java springboot logs :

```yaml
deployment:
fluentdConfigAnnotations:
regex: /^(?<time>\\d+(?:-\\d+){2}\\s+\\d+(?::\\d+){2}\\.\\d+)\\s*(?<level>\\S+)
(?<pid>\\d+) --- \\[(?<thread>[\\s\\S]*?)\\] (?<class>\\S+)\\s*:\\s*(?<message>[\\s\\S]*?)(?=\\g<time>|\\Z)/
regexFirstLine: /^\\d+(?:-\\d+){2}\\s+\\d+(?::\\d+){2}\\.\\d+/
timeFormat: "%Y-%m-%d %H:%M:%S.%L"
```
This will be parsed as follows:
```yaml
time: 2019-11-27 11:04:12.682
level: INFO
pid: 1
thread: nio-8080-exec-1
class: o.s.web.servlet.DispatcherServlet
message: Initializing Servlet 'dispatcherServlet'
```
## Log Retention
By default Application logs are retained for 7 days.
## Application alerting
Alerts can be sent to Slack channels by matching a string against a particular field. e.g. Send an alert to Slack if `level`==`ERROR`. These alerts increase operational efficiency. See [Application log alerting](../monitoring-stack/log-alerts.md#Application-Logs-Alerting) on how to configure alerts
- [Loki](https://github.com/grafana/loki)
- [Vector](https://github.com/vectordotdev/vector)
2 changes: 1 addition & 1 deletion content/managed-addons/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Here is the list of fully managed addons available on Stakater App Agility Platf

Managed AddOn | Description
--- | ---
Logging | [ElasticSearch, Fluentd and Kibana](./logging-stack/overview.md)
Logging | [Loki and Vector](./logging-stack/overview.md)
Monitoring | [Grafana, Prometheus, Thanos and Alertmanager](./monitoring-stack/overview.md)
CI (continuous integration) | [Tekton](./tekton/overview.md)
CD (continuous delivery) | [ArgoCD](./argocd/overview.md)
Expand Down
7 changes: 0 additions & 7 deletions theme_override/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,6 @@ nav:
- managed-addons/konfigurator/explanation/pod-metadata-injector.md
- Logging:
- managed-addons/logging-stack/overview.md
- managed-addons/logging-stack/kibana-view-logs.md
- Monitoring:
- managed-addons/monitoring-stack/overview.md
- managed-addons/monitoring-stack/stack.md
Expand Down Expand Up @@ -319,12 +318,6 @@ nav:
- help/k8s-concepts/cloud-native-app.md
- help/k8s-concepts/helm.md
- help/k8s-concepts/high-availability.md
- FAQs:
- help/faqs/product.md
- help/faqs/purchasing.md
- help/faqs/customization.md
- help/faqs/developers.md
- help/faqs/operations.md

plugins:
- include-markdown

0 comments on commit 61811da

Please sign in to comment.