Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement for alarms #215

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
e60ffbc
Enhancement for alarms
pixelsoccupied Sep 3, 2024
921c8d9
update requriment for when acknowledge is sent by user
pixelsoccupied Oct 1, 2024
7a3aa1b
fix render
pixelsoccupied Oct 1, 2024
031094b
clean up intro
pixelsoccupied Oct 1, 2024
4e9acdc
code review changes
pixelsoccupied Oct 3, 2024
180e0a9
improve mapping clarity
pixelsoccupied Oct 3, 2024
11d44c2
add query to retrieve probablecause data
pixelsoccupied Oct 3, 2024
d26596d
code review changes
pixelsoccupied Oct 3, 2024
dc34a4f
inlcude event record exmaple
pixelsoccupied Oct 3, 2024
f32fa40
updated postgres
pixelsoccupied Oct 3, 2024
d1678f9
update reviewers list
pixelsoccupied Oct 4, 2024
cd4c97d
improve probablecause info and update the example to reflect real data
pixelsoccupied Oct 4, 2024
c0007fe
specify that simple controller and remove whitespace
pixelsoccupied Oct 4, 2024
fe65442
clean up whitespace
pixelsoccupied Oct 4, 2024
5fb2e42
clean up whitespace
pixelsoccupied Oct 4, 2024
82f1ae2
clarify text
pixelsoccupied Oct 4, 2024
221aba4
add docs to explain the additional resourceType alerts support
pixelsoccupied Oct 8, 2024
ceff658
clarify postgres config
pixelsoccupied Oct 8, 2024
567f14b
prefer lookup over enum and other code review changes
pixelsoccupied Oct 9, 2024
d0d0c8e
add alegacy as reviewer and update timestamp
pixelsoccupied Oct 9, 2024
46fca41
specify alarms deployment CR and init DB steps need to be split when …
pixelsoccupied Oct 10, 2024
96b0d0c
specify o-ran endpoints to v1alpha1 to be more strict
pixelsoccupied Oct 10, 2024
023bcd0
fix oran apis to v1
pixelsoccupied Oct 11, 2024
9fd15cb
updates for code review, improve postgres creds requirement alarms se…
pixelsoccupied Oct 15, 2024
c543980
remove apis due to copy/paste error
pixelsoccupied Oct 15, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
specify alarms deployment CR and init DB steps need to be split when …
…deploying
pixelsoccupied committed Oct 10, 2024
commit 46fca415ee5e68c363524eb908214a355d9b8c3d
19 changes: 12 additions & 7 deletions docs/enhancements/infrastructure-monitoring-service-api/alarms.md
pixelsoccupied marked this conversation as resolved.
Show resolved Hide resolved
pixelsoccupied marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -713,18 +713,24 @@ WHERE probable_causes.probable_cause_id = 'f5ac4ac7-0ff3-40a2-b305-77313c28136a'
## K8s resources
We will need few K8s resources that will be eventually applied by the Operator.

### Jobs to Initialize Alarm Server DB
We need two Jobs that can help with DB

- One job that creates a Database using `CREATE DATBASE` cmd
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: spelling "DATBASE"

- One job that creates all the tables as part of migration (create new tables, updates, etc)
See [postgres](#postgres) for all the required credentials

#### Alarm server
This is essentially a typical CRUD app and we need the following

- Deployment: It should have one initiContainer to create a DB, one initContainers that perform DB migration (create/alter table etc)
and one main container which starts the main server.
No HA, so set replica to 1. It should also contain all the ENV variables needed to talk to postgres deployment DB_HOST, DB_PORT, DB_NAME, DB_USER etc.
Suitable resources should be provided but not much memory and CPU is need for CRUD apps.
- Deployment: one main container which starts the main server.
No HA, so set replica to 1. It should also contain all the ENV variables needed to talk to postgres deployment DB_HOST, DB_PORT, DB_USER etc (consult with POSTGRES deployment for latest).
DB_NAME will be set to whatever is used in [here](#jobs-to-initialize-alarm-server-db).
Suitable resources should be provided but not much memory and CPU is need for CRUD apps (TBD, need to experiment for exact values).
- Secrets: DB creds and configs should be read from postgres deployment.
- Service: Expose and balance using `ClusterIP` (though to start with we will set replica to 1)
- Ingress: Expose service so that it can be called by users from outside the cluster


#### Postgres
This deployment can be leveraged by many microservices by creating their own Database.
pixelsoccupied marked this conversation as resolved.
Show resolved Hide resolved

@@ -736,8 +742,7 @@ This deployment can be leveraged by many microservices by creating their own Dat
- Secrets: default creds needed to spin postgres, with type: Opaque. This secret will then be ready by
- POSTGRES_USER: `o-ran`
- POSTGRES_PASSWORD: `o-ran`
- POSTGRES_DB: `o-ran` # Note: this is simply there to be explicit.
If not provided `POSTGRES_USER` is used to create default DB. But ultimately this DB not used as each service will create their own.
- POSTGRES_DB: `o-ran` # Note: this is simply there to be explicit. If not provided `POSTGRES_USER` is used to create default DB. But ultimately this DB will not be used as each service will create their own.
- ConfigMap: For others to know the hostname and port
- POSTGRES_HOST: "postgres.o-ran-namespace.svc.cluster.local"
- POSTGRES_PORT: "5432"