Skip to content

Commit

Permalink
feat: remove unneeded files and layout sidebar (#315)
Browse files Browse the repository at this point in the history
  • Loading branch information
mbystedt authored Aug 10, 2023
1 parent 6eeded0 commit 6e877ec
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 54 deletions.
22 changes: 14 additions & 8 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
<!-- docs/_sidebar.md -->

* [Home](/)
* [Online Training](/learning.md)
* [OpenSearch Architecture](/architecture.md)
* [Data Indices and Lifecycle](/indextemplate.md)
* [OpenSearch Common Schema](/commonschema.md)
* [Onboarding Process](/onboarding.md)
* [Funbucks for Flentbit Configuration](/fluentbit.md)
* [Lambda Testing](/testing.md)
* [Deployment](/deployment.md)
* Onboarding Planning
** [Onboarding Process](/onboarding.md)

* Output Application Events
** [Funbucks for Flentbit Configuration](/fluentbit.md)

* Events to OpenSearch Documents
** [Testing Event Stream Processing](/testing.md)
** [Deployment](/deployment.md)

* Reference
** [APM Architecture](/architecture.md)
** [Data Indices and Lifecycle](/indextemplate.md)
** [Data Schema](/commonschema.md)
17 changes: 1 addition & 16 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,5 @@
# OpenSearch Architecture
# APM Architecture

## Environment

OpenSearch Production: [https://apm.io.nrs.gov.bc.ca/_dashboards](https://apm.io.nrs.gov.bc.ca/_dashboards)

## Diagrams
![Data Collection](./images/datacollection.png)

![Data Management](./images/datamanagement.png)

## Log Consumption Architecture
![AWS ESC Web Service Architecture](./images/logconsumption.png)

## Deployment
OpenSearch is deployed using Terraform onto the AWS SEA using GitHub Actions. See: [nr-apm-stack](https://github.com/BCDevOps/nr-apm-stack)
```
Terraform is an open-source infrastructure as code software tool that provides a consistent CLI workflow to manage hundreds of cloud services. Terraform codifies cloud APIs into declarative configuration files.
Product website: https://www.terraform.io/
```
Binary file removed docs/images/logconsumption.png
Binary file not shown.
11 changes: 0 additions & 11 deletions docs/learning.md

This file was deleted.

21 changes: 2 additions & 19 deletions docs/onboarding.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,8 @@
# Onboarding Process

## Prerequsition

### Grant User(s) Access to OpenSearch
PR request on [auth-sync-config-opensearch
](https://github.com/bcgov-nr/auth-sync-config-opensearch)

Modify integration-roles.json under certain groups with user's email

| Access | Group Name |
|----------------------|-----------------------------------------------------------------|
| General | nrm-read-all |
| Full Access for Team | (team name)-write-all |
| Altering | alerting_ack_alerts, alerting_full_access, alerting_read_access |
| Anomaly | anomaly_full_access, anomaly_read_access |
| Admin | all_access |

## Onboarding Server Metrics to OpenSearch
Configure the new server in Github Repo [nr-funbucks](https://github.com/bcgov-nr/nr-funbucks/tree/main/config/server)

Example:
Example:

- Linux: [backup.json](https://github.com/bcgov-nr/nr-funbucks/blob/main/config/server/backup.json)

Expand Down Expand Up @@ -107,4 +90,4 @@ Documents about configuration for fluentbit is in [nr-funbucks](./fluentbit.md).
- Login [OpenSearch](https://apm.io.nrs.gov.bc.ca/_dashboards)
- menu -> Discover
- choose correct indices from dropdown list
- type search string in the search bar. For example: host.hostname: stress
- type search string in the search bar. For example: host.hostname: stress
1 change: 1 addition & 0 deletions event-stream-processing/samples/test.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"event.kind":"event", "message":"Started BackendStartApiApplication in 4.673 seconds (process running for 5.013)", "organization.id":"[email protected]", "ecs.version":"8.8", "organization.name":"TeamSPAR", "event.category":"web", "log.file.path":"/logs/postgres-api.log", "event.dataset":"application.log.utc", "event.sequence":19758, "labels.project":"spar-postgres-api", "service.name":"spar_postgres_api", "host":{"os":{}, "hostname":"encsabcamlt0324"}, "service.type":"postgres_api", "service.environment":"development", "agent.type":"fluentbit", "@timestamp":"2023-08-01T17:59:03.520Z", "agent.version":"2.1", "log.level":"INFO", "agent.name":"nr-spar-202", "event.ingested":"diagnostic", "@metadata.keyAsPath":"true", "log.logger":"c.b.g.b.BackendStartApiApplication"}

0 comments on commit 6e877ec

Please sign in to comment.