Tilgangsportalen Terraform Provider

DISCLAIMER

Note: This provider is based on an internal API and is of no use to others. Please do not use this provider unless you are working within Skatteetaten. The project is public because this is a requirement for being published to the official Terraform Registry.

Beskrivelse

Dette er en Terraform provider som lar deg definere roller og grupper i Tilgangsportalen ved hjelp av Terraform (infrastruktur som kode). Provideren er skrevet i Golang, og baserer seg på Hashicorp sitt Terraform Plugin Framework og Tilgangsportalen-APIet. Følgende guide fra hashicorp er brukt som utgangspunkt og inspirasjon i utviklingen av denne provideren: Implement a provider with the Terraform Plugin Framework. Provideren er tilgjengelig via terraform registry: terraform-provider-tilgangsportalen Provideren er utviklet internt i Skatteetaten, av Team Dataplattform, primært for å dekke våre egne behov. Vi håper den også vil komme andre til nytte. For spørsmål knyttet til provideren, for å melde feil, eller for å etterspørre ny funksjonalitet, kontakt oss via kontaktinformasjonen i kontakt-seksjonen av denne readme-en.

Ta i bruk provideren

Vi anbefaler at du tar i bruk provideren ved å referere til den publiserte versjonen i Terraform Registry.

terraform {
  required_providers {
    tilgangsportalen = {
      source  = "Skatteetaten/tilgangsportalen"
      version = "~>0.8"
    }
  }
}

provider "tilgangsportalen" {
  # It's recommended to use environment variables when configuring the provider
  # hosturl  = var.tilgangsportalen_url
  # username = var.tilgangsportalen_username
  # password = var.tilgangsportalen_password
}

Miljøvariabler

Følgende konfigurasjonsattributter kan settes via miljøvariabler:

Argument	Miljøvariabel
hosturl	TILGANGSPORTALEN_URL
username	TILGANGSPORTALEN_USERNAME
password	TILGANGSPORTALEN_PASSWORD

Tilgjengelig funksjonalitet

Tilgjengelig funksjonalitet er begrenset av tilgjengelige API-metoder for Tilgangsportalen-API-et. Provideren lar deg opprette, endre, og slette tilgangsportal-roller, opprette og slette Entra ID-grupper, og knytte disse sammen. Det finnes også funksjonalitet for å liste ut roller, grupper, og koblinger mellom disse. Merk at du kun vil ha mulighet til å endre eller slette roller og grupper eid av (dette betyr som hovedregel opprettet av) den brukeren du identifiserer deg med mot Tilgangsportalen.

Kom i gang med utvikling

Installer avhengigheter

Go >=1.21

brew install go

Terraform >= 1.5+

brew tap hashicorp/tap
brew install hashicorp/tap/terraform

For å kunne definere og endre roller og grupper i Tilgangsportalen trenger du en gyldig bruker mot Tilgangsportalen API-et.

Bygg av provideren

1. Klon dette repoet
2. Naviger til terraform-provider-tilgangsportalen/internal
3. Kjør kommandoen go install all

go install all

Oppdatere avhengigheter

Avhengigheter kan oppdateres med:

go mod tidy

Bygg deretter provideren på nytt:

go install all

Det anbefales bruk av repoets make-fil under utvikling for å enkelt bygge provideren oppdatere avhengigheter og generere dokumentasjon. Eksempelvis:

make

Verifiser installasjonen

Test av provideren kjøres mot Tilgangsportalens test-api. Vi må sette lokale variabler for URL og autentisering for å kunne kjøre lokalt: Sett hemmeligheter (via nano ~/.zshrc):

export TILGANGSPORTALEN_USERNAME='DittBrukernavnHer'
export TILGANGSPORTALEN_PASSWORD='DittPassordHer'
export TILGANGSPORTALEN_URL='https://tilgang-test.sits.no/ApiServer'

Det vil også være nødvendig å overskrive addressen for terraform provideren under utvikling:

Opprett en .terraformrc-fil i på hjemmeområdet ditt:

cd $HOME
nano .terraformrc

Legg til følgende (husk å bytte ut <Username>):

provider_installation {

  dev_overrides {
      "registry.terraform.io/Skatteetaten/tilgangsportalen" = "/Users/<Username>/go/bin"
  }

  # For all other providers, install them directly from their origin provider
  # registries as normal. If you omit this, Terraform will _only_ use
  # the dev_overrides block, and so no other providers will be available.
  direct {}
}

Naviger deretter til terraform-provider-tilgangsportalen/examples/provider-install-verification. Endre ev. i terraform-filene der for å definere roller, assignments, outputs e.l, og kjør deretter terraform plan:

terraform plan

Verifiser at det genereres en gyldig plan mot Tilgangsportalen.

Du kan kjøre terraform plan på samme måte for å opprette de ressursene du har definert. Ressursene opprettes i test.

Kjør tester

Det er lagt inn en rekke akseptansetester for provideren. Disse kjører mot Tilgangsportalen sitt API i test. For å kjøre testene trenger du å legge inne to testbruker-identer. Disse må være gyldige brukeridenter i Tilgangsportalen. Du kan f.eks. sette de via nano ~/.zshrc som for de andre variablene (bytt ut med en gyldig ident, f.eks. din egen):

export ACC_TEST_SYSTEM_ROLE_OWNER='a00000'
export ACC_TEST_SYSTEM_ROLE_SECURITY_OWNER='b00000'

For at testene skal kjøre må TF_ACC være satt til en verdi. Denne kan du sette når du vil kjøre tester. Naviger til mappen testene er i (de slutter på _test.go) og kjør TF_ACC=1 go test -count=1 -run='NavnPåTest' -v for å kjøre en spesifikk test, eller TF_ACC=1 go test -count=1 -v for å kjøre alle. Dersom du vil sjekke coverage for testene, kan du kjøre TF_ACC=1 go test -cover.

Generere dokumentasjon

Vi bruker terraform-plugin-docs for å generere dokumentasjon. Slik installerer du og kjører det:

make generate-docs

Mer dokumentasjon ligger på GitHub: https://github.com/hashicorp/terraform-plugin-docs

Kontaktinformasjon

Team Dataplattform kan nås på <dataplattform(at)skatteetaten.no>.