- Added common docs for OpenSearch.

- Updated README.md in /apps.
navikt · Nov 26, 2024 · d393c93 · d393c93
1 parent ef2d381
commit d393c93
Show file tree

Hide file tree

Showing 56 changed files with 142 additions and 756 deletions.
diff --git a/README.md b/README.md
@@ -7,62 +7,16 @@
 Info/lenker til Team Dollys interne verktøy finnes [her](https://navikt.github.io/testnorge/).
 
 ## Bygging/Kjøring
-### Kjør lokalt
-
-**NB: `navtunnel` må kjøre, eller man må være logget inn med `naisdevice`**
-
-For å kunne hente ned alle avheningehter må det opprettes en Personal access tokens fra https://github.com/settings/tokens. Denne token må legges inn i system variabler NAV_TOKEN.
-
-Fra Mac
-```
-/etc/profile
-export NAV_TOKEN=xxxx-yyyy-zzzz
-```
-
-Gradle følger med prosjektet og `./gradlew build` vil derfor fungere. `gradle build` bruker lokalt installert Gradle.
-
-
-### Utviklerimage
-- Opprett Personal access tokens i Github og legg til token som systemvariabelen NAV_TOKEN (se forklaring over)
-- Opprett `gradle.properties` under `C:/Users/%USERNAME%/.gradle` med innhold (bytt ut truststorepassord og -path):
-```
-systemProp.http.proxyHost=webproxy-utvikler.nav.no
-systemProp.http.proxyPort=8088
-systemProp.http.nonProxyHosts=localhost|127.0.0.1|*.local|*.adeo.no|*.nav.no|*.aetat.no|*.devillo.no|*.oera.no|*devel
-systemProp.https.proxyHost=webproxy-utvikler.nav.no
-systemProp.https.proxyPort=8088
-systemProp.https.nonProxyHosts=localhost|127.0.0.1|*.local|*.adeo.no|*.nav.no|*.aetat.no|*.devillo.no|*.oera.no|*devel
-systemProp.javax.net.ssl.trustStorePassword=TRUSTSTORE_PASS
-systemProp.javax.net.ssl.trustStore=TRUSTSTORE_PATH
-```
-- Legg til sertifikat til truststore: https://plugins.gradle.org og https://repository-cdn.liferay.com/nexus/content/groups/public 
-    - Åpne URL i nettleser
-    - Trykk på hengelås til venstre for URL og klikk på "Sertifikat"
-    - Velg fanen "Detaljer" og klikk "Kopier til fil". Last ned DER-kodet binær. Merk at sertifikatet får filformat .cer
-    - Sertifikat legges til TrustStore ved hjelp av kommandoen:
-        ``keytool -import -trustcacerts -alias ALIAS -file DIN_DOWNLOAD_DIR/SERTIFIKAT_FILNAVN.cer -keystore PATH_TIL_KEYSTORE/KEYSTORE_FILNAVN.jts``
-- Hvis punktene over ikke er tilstrekkelig og prosjektet sliter med å hente pakker fra maven, forsøk å legge til denne 
-under repositories i `java-conventions.gradle` (MERK! Denne må fjernes igjen før commit):
-``` 
-maven {
-          url = uri('https://repo.adeo.no/repository/github-package-registry-navikt')
-      }
-```
-## Dokumentasjon
-Enhver applikasjon skal ha dokumentasjon i fila `<min-testnorge-app>/README.md`. Hver av disse filene må starte med
-```
----
-layout: default
-title: min-app
-parent: Applikasjoner
----
-
-# min-app
-[...]
-```
-for å bli vist på riktig måte under https://navikt.github.io/testnorge.
-README-filen skal beskrive kort hva appen er til, og hvordan den fungerer. Det er også fint om du beskriver kort
-info om lokal kjøring osv.
+> **Mac:**
+> 
+> For å kjøre tester som bruker Testcontainers eller kjøre en applikasjon lokalt som krever en tjeneste kjørende i Docker så må disse miljøvariablene settes:
+>
+> `DOCKER_HOST=unix://${HOME}/.colima/default/docker.sock`\
+> `TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock`\
+> `TESTCONTAINERS_RYUK_DISABLED=true`
+
+### Lokal kjøring
+Se `README.md` for hver enkelt applikasjon/proxy. Felles dokumentasjon ligger i [/docs](./docs).
 
 ## Migrering inn i monorepo
 

diff --git a/apps/adresse-service/README.md b/apps/adresse-service/README.md
@@ -1,21 +1,7 @@
 # Adresse-service
 Adresse-service gir tilgang til adresser fra PDL.  
 Søk kan gjøres på postnummer, kommunenummer, fritekstsøk, mm
-
-## Swagger
-Swagger finnes under [/swagger](https://testnav-adresse-service.intern.dev.nav.no/swagger) -endepunktet til
-applikasjonen.
 
 ## Lokal kjøring
-Ha naisdevice kjørende og kjør AdresseServiceApplicationStarter med følgende argumenter:
-```
--Dspring.profiles.active=local
---add-opens java.base/java.lang=ALL-UNNAMED
-```
-
-### Utviklerimage
-I utviklerimage brukes ikke naisdevice og du må legge til følgende ekstra argumenter:
-```
--Djavax.net.ssl.trustStore=[path til lokal truststore]
--Djavax.net.ssl.trustStorePassword=[passord til lokal truststore]
-```
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
diff --git a/apps/amelding-service/README.md b/apps/amelding-service/README.md
@@ -1,11 +1,6 @@
 # Amelding-service
 Service for å sende syntetiske arbeidsmeldinger videre til oppsummerings-dokument-service.
 
-## Swagger
-Swagger finnes under [/swagger](https://testnav-amelding-service.intern.dev.nav.no/swagger) -endepunktet til
-applikasjonen.
-
 ## Lokal kjøring
-```
--Dspring.profiles.active=dev
-```
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
diff --git a/apps/app-tilgang-analyse-service/README.md b/apps/app-tilgang-analyse-service/README.md
@@ -10,22 +10,16 @@ Swagger finnes under [/swagger](https://testnav-app-tilgang-analyse-service.inte
 applikasjonen.
 
 ## Lokal kjøring
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
 
-### In Memmory DB
-Ha naisdevice kjørende og kjør AppTilgangAnalyseServiceApplicationStarter med følgende argumenter:
-```
--Dspring.profiles.active=local
-```
-
-### GCP DB
+En egen Spring profile _localdb_ er satt opp for å kjøre med proxy mot applikasjonens reelle DB.
 
-Kjør opp `cloud_sql_proxy`
+Kjør `cloud_sql_proxy` i bakgrunnen.
 ```
-./cloud_sql_proxy -instances=dolly-dev-ff83:europe-north1:testnav-app-tilgang-analyse-service=tcp:3306
+> cloud_sql_proxy -instances=dolly-dev-ff83:europe-north1:testnav-app-tilgang-analyse-service=tcp:3306
 ```
-
-Ha naisdevice kjørende og kjør AppTilgangAnalyseServiceApplicationStarter med følgende argumenter:
+Start applikasjonen med Spring profile _localdb_ og definer DB_PASSORD (kan hentes fra pod).
 ```
--Dspring.profiles.active=localdb
 -DDB_PASSWORD=[passord for testnav-app-tilgang-analyse-service-db]
-```
+```
diff --git a/apps/arbeidsforhold-service/README.md b/apps/arbeidsforhold-service/README.md
@@ -1,18 +1,6 @@
 # testnav-arbeidsforhold-service
 API for arbeidsforhold som hentes fra testnav-aareg-proxy.
 
-## Swagger
-Swagger finnes under [/swagger](https://testnav-arbeidsforhold-service.intern.dev.nav.no/swagger) -endepunktet til applikasjonen.
-
 ## Lokal kjøring
-Ha naisdevice kjørende og kjør ArbeidsforholdApiApplicationStarter med følgende argumenter:
-```
--Dspring.profiles.active=dev
-```
-
-### Utviklerimage
-I utviklerimage brukes ikke naisdevice og du må legge til følgende ekstra argumenter:
-```
--Djavax.net.ssl.trustStore=[path til lokal truststore]
--Djavax.net.ssl.trustStorePassword=[passord til lokal truststore]
-```
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
diff --git a/apps/batch-bestilling-service/README.md b/apps/batch-bestilling-service/README.md
@@ -1,18 +1,6 @@
 # Batch-bestilling-service
 App for å sende inn et stort antall bestillinger mot backend over tid, for å ikke overbelaste Dolly
 
-## Swagger
-Swagger finnes under [/swagger](https://testnav-batch-bestilling-service.intern.dev.nav.no/swagger) -endepunktet til applikasjonen.
-
 ## Lokal kjøring
-Ha naisdevice kjørende og kjør MiljoerServiceApplicationStarter med følgende argumenter:
-```
--Dspring.profiles.active=dev
-```
-
-### Utviklerimage
-I utviklerimage brukes ikke naisdevice og du må legge til følgende ekstra argumenter:
-```
--Djavax.net.ssl.trustStore=[path til lokal truststore]
--Djavax.net.ssl.trustStorePassword=[passord til lokal truststore]
-```
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
diff --git a/apps/brreg-stub/README.md b/apps/brreg-stub/README.md
@@ -15,13 +15,7 @@ For dokumentasjon av applikasjonen sine endepunkter:
  - `/api`
  - `WSDL: /ws`
 
-## Deployment
-
-Applikasjonen deployes til dev-fss ved bruk av [Github Actions.](https://github.com/navikt/testnorge/actions) Nytt bygg trigges ved PR eller merge til master. 
-
-Applikasjonen kan også startes opp lokalt ved å bruke LocalApplicationStarter
-
 ## Lokal kjøring
 * [Generelt.](../../docs/local_general.md)
-* [Lokal PSQL i Docker](../../docs/local_db.md)
+* [Lokal PostgreSQL.](../../docs/local_db.md)
 
diff --git a/apps/bruker-service/README.md b/apps/bruker-service/README.md
@@ -3,13 +3,6 @@
 Service som henter og validerer en ansatt fra en reell organisasjon og brukes for autensiering ved bruk av våre
 applikasjoner som har bankId innlogging.
 
-## Swagger
-
-Swagger finnes under [/swagger](https://testnav-bruker-service.intern.dev.nav.no/swagger) -endepunktet til
-applikasjonen.
-
 ## Lokal kjøring
-```
--Dspring.profiles.active=local
-```
+* [Generelt.](../../docs/local_general.md)
 
diff --git a/apps/budpro-service/README.md b/apps/budpro-service/README.md
@@ -5,12 +5,10 @@ Startes lokalt på samme måte som alle andre. Spring profile `local`. Se endepu
 Kun én integrasjon, med _generer-navn-service_.
 
 **Kilder:**
+* [Kommuner](https://www.ssb.no/klass/klassifikasjoner/131)
+* [Stillinger](https://www.ssb.no/arbeid-og-lonn/sysselsetting/artikler/yrkeskatalogen)
+* [Organisasjonsenhet](https://confluence.adeo.no/display/PK/PK-6917?preview=%2F68215567%2F101614076%2FHR+ORGANISASJONSSTRUKTUR2.xls)
 
-*Kommuner:*
-> https://www.ssb.no/klass/klassifikasjoner/131
-
-*Stillinger:*
-> https://www.ssb.no/arbeid-og-lonn/sysselsetting/artikler/yrkeskatalogen
-
-*Organisasjonsenhet:*
-> https://confluence.adeo.no/display/PK/PK-6917?preview=%2F68215567%2F101614076%2FHR+ORGANISASJONSSTRUKTUR2.xls
+## Lokal kjøring
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
diff --git a/apps/dolly-backend/README.md b/apps/dolly-backend/README.md
@@ -13,26 +13,8 @@ Applikasjonen legger også ved potensielle standard verdier som kreves i API vi
 trenger å ha noe forhold til under utfylling av bestilling. Noe data blir persistert i postgres db, som f.eks brukerne
 av Dolly, bestillingskriterier, hvem som har sendt de inn og status på disse.
 
-## Utenfor utviklerimage
-
-https://dolly.ekstern.dev.nav.no/swagger-ui.html
-
-## Fra utviklerimage
-
-https://dolly-backend.intern.dev.nav.no/swagger-ui.html
-
-## Kjør lokalt
-* Se [generell informasjon](../../docs/local_general.md).
-* Applikasjonen er avhengig av en database i GCP, se [egen dokumentasjon](../../docs/gcp_db.md).
-* Applikasjonen er avhengig av OpenSearch:
-```aiexclude
-> docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" -e "plugins.security.disabled=true" -e "OPENSEARCH_INITIAL_ADMIN_PASSWORD=YLAgOm}rz#o6#Aq" --name opensearch -d opensearchproject/opensearch:latest
-```
-Legg merke til passord `YLAgOm}rz#o6#Aq` (tilfeldig [generert](https://www.strongpasswordgenerator.org/), men må være "sterkt" ellers vil ikke OpenSearch starte).
-
-**Mac:** For å kjøre tester og bygge appen lokalt må Docker (Colima kan brukes) kjøre og man er nødt til å sette disse miljøvariablene:
-```
-DOCKER_HOST=unix://${HOME}/.colima/default/docker.sock
-TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock
-TESTCONTAINERS_RYUK_DISABLED=true
-```
+## Lokal kjøring
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
+* [Database i GCP.](../../docs/gcp_db.md)
+* [OpenSearch.](../../docs/local_opensearch.md)
diff --git a/apps/dolly-frontend/README.md b/apps/dolly-frontend/README.md
@@ -4,11 +4,9 @@ Prosjekt for å opprette og konfigurere personer knyttet til fellesregistrene i
 
 ## Dokumentasjon
 
-### Swagger
-
-Swagger finnes under /swagger-ui.html
-
 ## Lokal kjøring
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
 
 ### Javascript
 
@@ -26,55 +24,6 @@ generate new token (må ha read:packages og repo tilgang)
 
 .npmrc filen skal ligge i brukermappen (cd ~) din, hvis den ikke finnes der må du opprette den.
 
-### Java
-
-For å kjøre lokalt (DollyFrontendApplicationStarter) må active profile settes til `local`.
-
-Disse verdiene fylles deretter inn i VM Options på IDE:
-
-Run -> Edit Configurations -> VM Options
-
-```
--Dspring.profiles.active=local
-```
-
-#### Utviklerimage
-
-For å kunne gjøre kall mot NAIS apper fra utviklerimage, må nav truststore settes opp og følgende verdier må
-også legges til i VM Options:
-
-```
--Djavax.net.ssl.trustStore=C:\path\to\truststore
--Djavax.net.ssl.trustStorePassword=(Passord)
-```
-
-##### Legge til sertifikat i truststore:
-
-Dersom det dukker opp RunTimeException under oppstart kan det være at du mangler sertifikat i din truststore.
-
-Sertifikat kan hentes
-fra [Microsoft Login Cert](https://login.microsoftonline.com/62366534-1ec3-4962-8869-9b5535279d0b/login) (Ignorer
-feilmeldingen om POST)
-
-For Mac:
-
-- Trykk på hengelåsen til venstre for URL og klikk deretter på sertifikat
-
-![Microsoft Sertifikat](../../docs/applications/dolly/assets/microsoft_keychain.png)
-
-- Klikk på pilen ved siden av detaljer og bla helt ned
-
-![Sertifikat Detaljer](../../docs/applications/dolly/assets/cert_details.png)
-
-- Ved å trykke på linken vil sertifikat lastes ned og man kan deretter legge denne til i Truststore ved hjelp av
-  kommandoen:
-
-```
-keytool -import -trustcacerts -alias MicrosoftLoginCert -file DIN_DOWNLOAD_DIR/DigiCertSHA2SecureServerCA.crt -keystore PATH_TIL_DIN_KEYSTORE.jts
-```
-
-![Sertifikat Download](../../docs/applications/dolly/assets/cert_download.png)
-
 ### Kjøre Redis lokalt
 
 Evt last ned colima og kjør

diff --git a/apps/dollystatus/README.md b/apps/dollystatus/README.md
@@ -5,8 +5,8 @@ Applikasjon for viser status på forskjellig applikasjoner og tjeneserter fra Do
 Lenke https://dollystatus.intern.dev.nav.no/ 
 
 ## Lokal kjøring
-Ha naisdevice kjørende og i "src/main/js" mappe kjør
+Fra `/src/main/js` kjør
 ```
-npm install
-npm start
+> npm install
+> npm start
 ```
diff --git a/apps/endringsmelding-frontend/README.md b/apps/endringsmelding-frontend/README.md
@@ -6,8 +6,5 @@ azure-applikasjonen `dev-gcp:dolly:endringsmelding-frontend`.
 https://testnav-endringsmelding.intern.dev.nav.no
 
 ## Lokal kjøring
-
-For å kjøre lokalt (DollyFrontendRedirectApplicationStarter) må active profile settes til `dev`.
-```
--Dspring.profiles.active=dev
-```
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)
diff --git a/apps/endringsmelding-service/README.md b/apps/endringsmelding-service/README.md
@@ -3,24 +3,6 @@
 Service for endringsmeldinger som håndterer kallene fra Endringsmelding-frontend. Sender foedsel og døds meldinger på
 test identer.
 
-## Swagger
-
-Swagger finnes under [/swagger](https://testnav-endringsmelding-service.intern.dev.nav.no/swagger) -endepunktet til
-applikasjonen. For å kunne bruke endringsmelding-endepunktet må det innsendte tokenet ha tilgang via azure
-applikasjonen `dev-gcp:dolly:endringsmelding-frontend`.
-
 ## Lokal kjøring
-
-Ha naisdevice kjørende og kjør EndringsmeldingServiceApplicationStarter med følgende argumenter:
-```
--Dspring.profiles.active=dev
-```
-
-### Utviklerimage
-
-I utviklerimage brukes ikke naisdevice og du må legge til følgende ekstra argumenter:
-
-```
--Djavax.net.ssl.trustStore=[path til lokal truststore]
--Djavax.net.ssl.trustStorePassword=[passord til lokal truststore]
-```
+* [Generelt.](../../docs/local_general.md)
+* [Secret Manager.](../../docs/local_secretmanager.md)