R Academy · leksjon

Distribuere Plumber-API-er til produksjon

Konteineriser og distribuer Plumber-API-er med Docker og skyplattformer.

Leksjon 4 av 413 trinn

Distribuere Plumber-API-er til produksjon er en gratis leksjon i R Academy på CoddyKit. Dette er leksjon 4 av 4. Du kan lese valgfritt 3 leksjoner fra denne læringsstien gratis i sin helhet – deretter låser CoddyKit PRO opp alle leksjoner, samt praktisk øving med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i R Academy, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i R Academy inneholder totalt 4 leksjoner.

Alternativer for produksjonsdistribusjon

Et Plumber-API kan distribueres på flere måter:

  • Docker-container – portabel, reproduserbar og fungerer overalt
  • Posit Connect – distribusjon med ett klikk og støtte for planlegging
  • Digital Ocean / EC2 – en vanlig Linux-VM som kjører R

Docker er det mest portable alternativet og bransjestandarden for R-API-er i produksjon.

Inngangspunkt for Plumber-API-et

Opprett en toppnivåfil kalt api.R som starter Plumber-serveren. Bruk Sys.getenv('PORT', unset='8000') slik at porten kan angis av containerorkestratoren uten at koden må endres.

# api.R
# library(plumber)
#
# pr <- plumb('routes.R')
# port <- as.integer(Sys.getenv('PORT', unset = '8000'))
# pr$run(host = '0.0.0.0', port = port)
#
# Listening on 0.0.0.0 is required inside Docker
# (127.0.0.1 is only reachable inside the container)

Basis-Docker-image – rocker/r-ver

Imagen rocker/r-ver tilbyr et minimalt R-miljø med fastlåst versjon. Fastlås alltid en bestemt R-versjon, for eksempel rocker/r-ver:4.3.2, for å sikre reproduserbare bygg. Unngå :latest i produksjon.

# Dockerfile
# FROM rocker/r-ver:4.3.2
#
# Alternatively use rocker/plumber which pre-installs plumber:
# FROM rstudio/plumber:latest
#
# rocker/r-ver is more minimal and gives you full control
# over which packages are installed.

Installere R-pakker i Dockerfile

Bruk RUN Rscript -e "install.packages(...)" til å installere pakker under byggingen av imaget. Installer systemavhengigheter først, for eksempel libssl-dev for httr2, ved hjelp av apt-get.

# FROM rocker/r-ver:4.3.2
#
# RUN apt-get update && apt-get install -y \
#     libssl-dev \
#     libcurl4-openssl-dev \
#  && rm -rf /var/lib/apt/lists/*
#
# RUN Rscript -e "install.packages(c('plumber', 'jsonlite', 'httr2'), repos='https://cloud.r-project.org')"

Kopiere filer og angi porten

Kopier R-kildefilene til containeren med COPY. Deklarer porten med EXPOSE slik at Docker vet hvilken port containeren lytter på. Dette er bare dokumentasjon – porten publiseres ikke.

# FROM rocker/r-ver:4.3.2
# ...
# WORKDIR /app
# COPY routes.R .
# COPY api.R .
#
# EXPOSE 8000
#
# CMD ["Rscript", "api.R"]

Bygge og kjøre Docker-imaget

Bygg imaget med docker build, og kjør deretter en container som kobler vertsporten til containerporten. Flagget -e injiserer miljøvariabler for hemmeligheter.

# Build the image:
# docker build -t my-r-api:1.0 .
#
# Run a container:
# docker run -d \
#   -p 8000:8000 \
#   -e API_SECRET_KEY='my_secret' \
#   -e DATABASE_URL='postgres://...' \
#   --name r-api \
#   my-r-api:1.0
#
# Test:
# curl http://localhost:8000/ping

Lese hemmeligheter med Sys.getenv()

I produksjon må De aldri legge hemmeligheter i Dockerfile eller kildekode. Les dem ved kjøring med Sys.getenv(). Send dem inn via Docker-flaggene -e, Kubernetes-hemmeligheter eller systemer for håndtering av miljøvariabler, for eksempel AWS Secrets Manager.

# In routes.R:
# db_url   <- Sys.getenv('DATABASE_URL', unset = '')
# api_key  <- Sys.getenv('API_SECRET_KEY', unset = '')
#
# if (nchar(db_url) == 0)  stop('DATABASE_URL is required')
# if (nchar(api_key) == 0) stop('API_SECRET_KEY is required')
#
# Fail fast at startup rather than failing silently at request time
cat('Validate all required env vars at startup with stop()
')

Endepunkt for helsesjekk

Et /ping- eller /health-endepunkt lar lastbalansere og orkestratorer (Kubernetes, ECS) bekrefte at API-et er tilgjengelig. Det bør returnere 200 raskt uten autentisering, og kan eventuelt kontrollere databasetilkoblingen.

# #* Health check
# #* @preempt auth
# #* @get /ping
# function() {
#   list(
#     status  = 'ok',
#     version = '1.0.0',
#     time    = format(Sys.time(), '%Y-%m-%dT%H:%M:%SZ')
#   )
# }
#
# Docker HEALTHCHECK:
# HEALTHCHECK CMD curl -f http://localhost:8000/ping || exit 1

Komplett Dockerfile-eksempel

Slik settes alt sammen – en Dockerfile som er klar for produksjon av et Plumber-API:

# FROM rocker/r-ver:4.3.2
# RUN apt-get update && apt-get install -y libssl-dev libcurl4-openssl-dev \
#  && rm -rf /var/lib/apt/lists/*
# RUN Rscript -e "install.packages(c('plumber','jsonlite'), repos='https://cloud.r-project.org')"
# WORKDIR /app
# COPY routes.R api.R ./
# EXPOSE 8000
# HEALTHCHECK CMD curl -f http://localhost:8000/ping || exit 1
# CMD ["Rscript", "api.R"]

Logging i produksjon

Strukturert logging gjør det enklere å diagnostisere problemer i produksjon. Bruk cat() eller pakken logger til å skrive tidsstemplete logger til stdout – Docker og de fleste plattformer fanger automatisk opp stdout og sender innholdet til en loggsamler.

# Log format: ISO timestamp + level + message
log_info <- function(msg) {
  cat(format(Sys.time(), '%Y-%m-%dT%H:%M:%S'), '[INFO]', msg, '
')
}

log_info('API starting up')
log_info(paste('Port:', Sys.getenv('PORT', '8000')))

Reverse proxy med Nginx

I produksjon bør De plassere en Nginx reverse proxy foran Plumber for å håndtere TLS-terminering, hastighetsbegrensning og buffering av forespørsler. Nginx sender forespørsler videre til Plumber på localhost, mens omverdenen kobler seg til Nginx på port 443.

# Nginx config snippet (nginx.conf):
# server {
#   listen 443 ssl;
#   ssl_certificate     /etc/letsencrypt/.../fullchain.pem;
#   ssl_certificate_key /etc/letsencrypt/.../privkey.pem;
#
#   location /api/ {
#     proxy_pass         http://127.0.0.1:8000/;
#     proxy_set_header   Host $host;
#     proxy_set_header   X-Real-IP $remote_addr;
#   }
# }

Hurtigsjekk: Docker EXPOSE

Hva gjør instruksjonen EXPOSE 8000 i en Dockerfile egentlig?

Oppsummering av distribusjon av Plumber-API-er

Viktige trinn ved distribusjon av Plumber i produksjon:

  • Lytt på 0.0.0.0, og les PORT fra miljøet
  • Bruk rocker/r-ver:X.Y.Z (med fastlåst versjon) som basisimage
  • Installer pakker i Dockerfile, og kopier bare kildefiler
  • Injiser hemmeligheter via miljøvariabler med -e – aldri i kildekode eller Dockerfile
  • Legg til et /ping-endepunkt for helsesjekk (med #* @preempt auth)
  • Bruk Nginx som reverse proxy for TLS og hastighetsbegrensning
Gratis å komme i gang

Lær deg R med en AI-veileder – gratis

Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.

Kurs
43
Leksjoner
159

Ofte stilte spørsmål

Er leksjonen «Distribuere Plumber-API-er til produksjon» gratis?

Ja – du kan lese valgfritt 3 av leksjonene i læringsstien R Academy, inkludert «Distribuere Plumber-API-er til produksjon», gratis i sin helhet her på nettet. Deretter låser CoddyKit PRO opp alle leksjoner, samt interaktiv øving med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Kurset i R Academy inneholder totalt 4 leksjoner.

Hva lærer jeg i «Distribuere Plumber-API-er til produksjon»?

Konteineriser og distribuer Plumber-API-er med Docker og skyplattformer. Du øver på R Academy med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.

Trenger jeg erfaring for å begynne med R Academy?

Ingen tidligere erfaring er nødvendig. R Academy på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 4 av 4.

Hvor lang tid tar leksjonen «Distribuere Plumber-API-er til produksjon»?

De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.

Kan jeg skrive og kjøre kode i denne R Academy-leksjonen?

Ja. Alle R Academy-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.

Alle leksjonene i dette kurset

  1. Introduksjon til Plumber og REST
  2. Opprette GET- og POST-endepunkter
  3. Autentisering og API-sikkerhet
  4. Distribuere Plumber-API-er til produksjon
← Tilbake til R Academy