From e857968570c039637cc78dd896d660316ca77db7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=98yvind=20Bruer-Skarsb=C3=B8?= Date: Mon, 23 Oct 2023 08:49:41 +0200 Subject: [PATCH] Changed a few components --- dapla-manual/_quarto.yml | 30 +- .../{dapla-test5.mp4 => dapla-animation.mp4} | Bin dapla-manual/index.qmd | 7 +- dapla-manual/om-dapla.qmd | 1 + dapla-manual/statistikkere/gcc.qmd | 2 +- dapla-manual/statistikkere/introduksjon.qmd | 4 + dapla-manual/theme.scss | 3 + .../utviklere/Infrastructure-as-Code.html | 292 ------------------ dapla-manual/utviklere/iac.qmd | 130 +++++++- 9 files changed, 166 insertions(+), 303 deletions(-) rename dapla-manual/images/{dapla-test5.mp4 => dapla-animation.mp4} (100%) create mode 100644 dapla-manual/om-dapla.qmd create mode 100644 dapla-manual/theme.scss delete mode 100644 dapla-manual/utviklere/Infrastructure-as-Code.html diff --git a/dapla-manual/_quarto.yml b/dapla-manual/_quarto.yml index 4e91874a..b5887a7f 100644 --- a/dapla-manual/_quarto.yml +++ b/dapla-manual/_quarto.yml @@ -8,11 +8,12 @@ website: title: "Dapla-manualen" image: images/dapla-long.png favicon: images/dapla-favicon.png - repo-url: https://github.com/statisticsnorway/dapla-manual + repo-url: https://github.com/statisticsnorway/dapla-manual-internal + issue-url: https://github.com/statisticsnorway/dapla-manual-internal/issues/new repo-actions: [edit, issue] + twitter-card: true + page-navigation: true open-graph: true - search: - location: sidebar page-footer: left: This is site heavily inspired by the @@ -22,8 +23,10 @@ website: navbar: logo: images/dapla-long.png + logo-alt: "Logo for Dapla" background: "#F0F8F9" # "Dark 1" from https://design.ssb.no/#/components/color foreground: "#274247" # "Dark 5" from https://design.ssb.no/#/components/color + search: true left: - text: Statistikkere href: statistikkere/introduksjon.qmd @@ -31,6 +34,8 @@ website: href: utviklere/index.qmd - text: Eksempler href: notebooks/index.qmd + - text: "Om Dapla" + href: om-dapla.qmd - text: Hjelp menu: - text: Opprette Dapla-team @@ -43,9 +48,24 @@ website: icon: send-fill href: https://ssb.pureservice.com/#/new/7 right: + - text: "Logg inn" + icon: person-circle + menu: + - text: "DaplaHub" + href: https://datahub.external.staging.ssb.cloud.nais.io/explore + icon: database-fill + - text: "DaplaLab" + href: om-dapla.qmd + icon: graph-up + - text: "JupyterLab (legacy)" + href: hhttps://jupyter.dapla.ssb.no/ + icon: journal-code + - text: "Google Cloud Console" + href: https://console.cloud.google.com/ + icon: google - icon: github href: https://github.com/statisticsnorway/dapla-manual - aria-label: Dapla-manual GitHub + aria-label: Dapla-manual GitHub repository sidebar: - id: statistikkere @@ -128,6 +148,6 @@ format: html: toc: true collapse-level: 1 - theme: cosmo + theme: [cosmo, theme.scss] code-copy: true code-overflow: wrap diff --git a/dapla-manual/images/dapla-test5.mp4 b/dapla-manual/images/dapla-animation.mp4 similarity index 100% rename from dapla-manual/images/dapla-test5.mp4 rename to dapla-manual/images/dapla-animation.mp4 diff --git a/dapla-manual/index.qmd b/dapla-manual/index.qmd index adbe5267..febbc111 100644 --- a/dapla-manual/index.qmd +++ b/dapla-manual/index.qmd @@ -33,16 +33,15 @@ resources: ### Hvordan? Hva? Hvorfor? Dapla-manualen gjør overgangen til Dapla enklere. ::: {.hero-buttons} -[Hurtigstart](./statistikkere/introduksjon.qmd){.btn-action-primary .btn-action .btn .btn-success .btn-lg role="button"} -[Manual](docs/guide/){#btn-guide .btn-action .btn .btn-info .btn-lg role="button"} -[Logg inn på Dapla](https://jupyter.dapla.ssb.no/){#btn-guide .btn-action .btn .btn-info .btn-lg role="button"} +[For statistikkere](./statistikkere/introduksjon.qmd){.btn-action-primary .btn-action .btn .btn-success .btn-lg role="button"} +[For utviklere](docs/guide/){#btn-guide .btn-action .btn .btn-info .btn-lg role="button"} ::: ::: ::: {.hero-animation} ::: diff --git a/dapla-manual/om-dapla.qmd b/dapla-manual/om-dapla.qmd new file mode 100644 index 00000000..d5b33cc0 --- /dev/null +++ b/dapla-manual/om-dapla.qmd @@ -0,0 +1 @@ +# Om Dapla \ No newline at end of file diff --git a/dapla-manual/statistikkere/gcc.qmd b/dapla-manual/statistikkere/gcc.qmd index 8dd58342..3ce3e900 100644 --- a/dapla-manual/statistikkere/gcc.qmd +++ b/dapla-manual/statistikkere/gcc.qmd @@ -17,7 +17,7 @@ Hvis du trykker på prosjektvelgeren vil det åpnes opp et nytt vindu. Sjekk at ![Prosjektvelgeren i Google Cloud Console](../images/prosjektvelger.png){fig-alt="Bilde som viser prosjektvelgeren i Google Cloud Console" #fig-prosjektvelger} ### Velg prosjekt -Her vises det hvordan man velger et prosjekt I [GCC](../gcc.qmd). Eksempelet benytter Dapla teamet `demo stat b` og fortsetter fra (@fig-prosjektvelger). +Her vises det hvordan man velger et prosjekt I [GCC](./gcc.qmd#prosjektvelger). Eksempelet benytter Dapla teamet `demo stat b` og fortsetter fra (@fig-prosjektvelger). 1. Skrive teamnavn i søkefeltet, resultatene burde se ut som i (@fig-sok). 1. Trykk på lenken `prod-demo-stat-b`, som markert med rød pil i (@fig-sok). diff --git a/dapla-manual/statistikkere/introduksjon.qmd b/dapla-manual/statistikkere/introduksjon.qmd index 1937000b..c40771a9 100644 --- a/dapla-manual/statistikkere/introduksjon.qmd +++ b/dapla-manual/statistikkere/introduksjon.qmd @@ -1,3 +1,7 @@ +--- +toc: false +--- + # Introduksjon {#sec-project-dice} Målet med dette kapittelet er å gi en grunnleggende innføring i hva som legges i ordet **Dapla**. I tillegg gis en forklaring på hvorfor disse valgene er tatt. \ No newline at end of file diff --git a/dapla-manual/theme.scss b/dapla-manual/theme.scss new file mode 100644 index 00000000..727200f4 --- /dev/null +++ b/dapla-manual/theme.scss @@ -0,0 +1,3 @@ +/*-- scss:defaults --*/ +$link-color: #143f90; +$text-muted: #6a737b; \ No newline at end of file diff --git a/dapla-manual/utviklere/Infrastructure-as-Code.html b/dapla-manual/utviklere/Infrastructure-as-Code.html deleted file mode 100644 index 0a8eb2af..00000000 --- a/dapla-manual/utviklere/Infrastructure-as-Code.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - -infrastructure-as-code - - - - - - - - - - - - - - - - - - - -
- -
- - - -
-

Infrastructure-as-Code (IaC)

-

løgkjfdskljfgkl

-
- -
- - -
- - - - \ No newline at end of file diff --git a/dapla-manual/utviklere/iac.qmd b/dapla-manual/utviklere/iac.qmd index cac8f43f..599d349c 100644 --- a/dapla-manual/utviklere/iac.qmd +++ b/dapla-manual/utviklere/iac.qmd @@ -1,3 +1,131 @@ # Infrastructure-as-Code (IaC) -løgkjfdskljfgkl \ No newline at end of file +## Struktur + +### Eksempel IaC-repo struktur + +```{.yaml filename="IaC-repo"} +dapla-example-iac +│ +├── automation +│ │ +│ └── source_data +│ │ +│ ├── dapla-example-test +│ │ +│ └── dapla-example-prod +│ +├── data +│ +├── docs +│ +├── infra +│ │ +│ ├── stack +│ │ +│ └── projects +│ │ +│ ├── dapla-example-test +│ │ │ +│ │ ├── project.yaml +│ │ │ +│ │ ├── ....tf +│ │ +│ └── dapla-example-prod +│ │ +│ ├── project.yaml +│ │ +│ ├── ....tf +│ +└── atlantis.yaml +``` + +### automation + +Mappe for skript som blir brukt av automatiseringstjenesten. + +### data + +Mappe for å ha metadata som teamet selv ønsker. + +::: {.callout-important title="Viktig"} +Data mappen er ikke ment for å lagre data til bruk i statistikkproduksjon. +::: + +### docs + +Mappe for å samle dokumentasjon. + +### infra + +Mappe for teamets infrastruktur. + +#### infra/projects.yaml + +Dette er en fil som teamet selv kan spesifisere prosjekter og features som er ønsket at et prosjekt skal ha. +Når man lager en PR etter å lagt inn f.eks et nytt prosjekt, så trigger det en Github Action som genererer Terraform koden som lager prosjektet. +`project_name` feltet skal ikke inneholde miljøtypen eller andre prefiks eller suffikser, disse blir automatisk lagt på. + +Eksemplet under vil lage 3 prosjekter i Google Cloud som vil få følgende prosjekt navn `dapla-example-p`, `dapla-example-t`, og `dapla-example-d`, prosjekt ID'ene vil være det samme bare med 2 tilfeldige karakterer på slutten. + +##### Eksempel projects.yaml + +```yaml +team_uniform_name: dapla-example + +projects: + - project_name: dapla-example + env: test + features: + - dapla-buckets + + - project_name: dapla-example + env: prod + features: + - dapla-buckets + - transfer-service + + - project_name: dapla-example + env: dev +``` + +##### Features +| Name | Description | Interacts with | +| -------- | -------- | -------- | +| `dapla-buckets` | Oppretter "standard" Dapla-bøttene (kilde, produkt, delt) samt et kildeprosjekt. | `transfer-service,disable-default-bucket-iam,disable-default-project-iam` | +| `transfer-service` | Oppretter bindinger for Transfer Service service kontoer | `dapla-buckets`| +| `source-data-automation` | Ikke helt klar ennå :) | `none` | +| `disable-default-project-iam` | Deaktiverer standard IAM-bindinger for standard Dapla-prosjekter | `dapla-buckets` | +| `disable-default-bucket-iam` | Deaktiverer standard IAM-bindinger for standard Dapla-bøttene | `dapla-buckets` | + +#### infra/projects + +Her er det en mappe for hvert prosjekt teamet har i Google Cloud. +Hvis man bruker `infra/projects.yaml` for å opprette prosjekter så blir det automatisk opprettet en egen mappe under her som inneholder all Terraform kode for det prosjektet. + +#### infra/stack + +Hvis teamet har noen gjenbrukbare moduler som skal brukes i alle prosjekter så kan de opprettes her. + +### atlantis.yaml + +Konfigurasjon av prosjektene Atlantis automatisk kjører `atlantis plan` for. +Hvis et prosjekt er opprettet via `infra/projects.yaml` så blir det automatisk lagt til i denne filen. + +#### Eksempel atlantis.yaml + +```yaml +version: 3 +parallel_plan: true +parallel_apply: true +projects: +- dir: ./infra/projects/dapla-example-prod + autoplan: + when_modified: ["*.tf", "terraform.tfvars", "*.yaml"] +- dir: ./infra/projects/dapla-example-test + autoplan: + when_modified: ["*.tf", "terraform.tfvars", "*.yaml"] +- dir: ./infra/projects/dapla-example-dev + autoplan: + when_modified: ["*.tf", "terraform.tfvars", "*.yaml"] +``` \ No newline at end of file