Slack-integrasjon

Koble din selvdriftede Status200 til Slack. Du oppretter en Slack-app fra manifestet serveren din genererer, gir Status200 appens påloggingsinformasjon og kobler hvert prosjekt til et arbeidsområde. Deretter legger Status200 ut hendelser, varsler og planlagt vedlikehold i kanalene dine, og teamet ditt håndterer dem fra Slack.

Denne siden er for den som drifter Status200-serveren. Når Slack er koblet til, settes varslingsregler opp per prosjekt: se Slack.

Slik fungerer det#

Slack-appen er din egen: Den er installert i arbeidsområdet ditt og snakker bare med serveren din. Trafikken går begge veier, og hver retning trenger sin egen nettverkstilgang.

• Utgående: Status200 kaller Slacks Web API for å legge ut meldinger, opprette kanaler og laste opp bilder.
• Innkommende: Slack kaller fire ruter på serveren din for hendelser, klikk på knapper, menyer og skråstrekkommandoer. Hver forespørsel er signert med appens signing secret. Status200 avviser en forespørsel der signaturen ikke stemmer eller tidsstempelet er mer enn fem minutter gammelt.

Før du begynner#

• Et Slack-arbeidsområde der du kan opprette og installere apper.
• Et offentlig HTTPS-vertsnavn for Status200 som Slack kan nå. Se Nettverkstilgang.
• Tilgang til serverens konfigurasjon: config.env for Docker Compose, eller Helm-values for Kubernetes.
• For å koble til et prosjekt: rollen Project Owner, Project Admin eller Project Member i det.

Sett opp Slack-appen#

1. Angi den offentlige URL-en#

   Status200 bygger appmanifestet og hver callback-URL fra HOST og HTTP_PROTOCOL. Sett dem til vertsnavnet Slack skal kalle, over HTTPS:

   Docker ComposeKubernetes

   Docker Compose

   config.envBash

   HOST=status200.example.com
   HTTP_PROTOCOL=https

   Kubernetes

   values.yamlYAML

   host: status200.example.com
   httpProtocol: https

   Disse verdiene genererer bare URL-er. De oppretter ikke DNS-poster, sertifikater eller brannmurregler.

2. Kopier appmanifestet#

   Åpne Prosjektinnstillinger > Arbeidsområde > Slack. Inntil Slack er satt opp på serveren, viser siden Integrating Slack with your Status200 Project med manifestet som er generert for vertsnavnet ditt. Det serveres også på https://status200.example.com/api/slack/app-manifest.

   Kontroller at hver URL i manifestet begynner med det offentlige vertsnavnet ditt. Hvis ikke, retter du først HOST og HTTP_PROTOCOL og tar i bruk endringen.

3. Opprett Slack-appen#

   Opprett en ny app fra et manifest på api.slack.com/apps, velg arbeidsområdet ditt, og lim inn manifestet. Bruk alltid manifestet din egen server genererer, slik at URL-ene i det passer til vertsnavnet ditt.

4. Kopier appens påloggingsinformasjon#

   Kopier Client ID, Client Secret og Signing Secret på appens side Basic Information under App Credentials.

5. Legg påloggingsinformasjonen inn i Status200#

   Docker ComposeKubernetes

   Docker Compose

   config.envBash

   SLACK_APP_CLIENT_ID=YOUR_SLACK_APP_CLIENT_ID
   SLACK_APP_CLIENT_SECRET=YOUR_SLACK_APP_CLIENT_SECRET
   SLACK_APP_SIGNING_SECRET=YOUR_SLACK_APP_SIGNING_SECRET

   Kubernetes

   values.yamlYAML

   slackApp:
     clientId: "YOUR_SLACK_APP_CLIENT_ID"
     clientSecret: "YOUR_SLACK_APP_CLIENT_SECRET"
     signingSecret: "YOUR_SLACK_APP_SIGNING_SECRET"

   For å holde verdiene i en Kubernetes-Secret som du administrerer selv, angir du i stedet slackApp.existingSecret: dens name og nøklene clientIdKey, clientSecretKey og signingSecretKey.

6. Ta i bruk konfigurasjonen#

   Docker ComposeKubernetes

   Docker Compose

   Bash

   npm run start

   Dette oppretter containerne på nytt med den nye config.env. docker compose restart leser den ikke inn på nytt.

   Kubernetes

   Bash

   helm upgrade my-oneuptime oneuptime/status200 -f values.yaml

   Når Status200 er oppe igjen, viser Prosjektinnstillinger > Arbeidsområde > Slack en knapp Connect with Slack i stedet for manifestet.

7. Bekreft forespørsels-URL-en for hendelser#

   Bekreft forespørsels-URL-en under Event Subscriptions i Slack-appen. Status200 svarer først på Slacks challenge når signing secret er satt, så prøv igjen hvis det mislyktes mens du opprettet appen.

8. Koble til prosjektet#

   Velg Connect with Slack under Prosjektinnstillinger > Arbeidsområde > Slack, og tillat appen i Slack. Slack sender deg tilbake til samme side, som nå viser arbeidsområdet ditt.

9. Koble til din egen Slack-konto#

   Knapper, skjemaer og kommandoer handler som Status200-brukeren som er knyttet til Slack-kontoen som bruker dem. Hver person åpner Brukerinnstillinger > Arbeidsområde > Slack og velger Connect my account with Slack. Den som ikke har koblet til en konto, får der de trykket et svar med en knapp Connect Slack account, som kobler den til i ett trinn.

Miljøvariabler#

Hva appen kan gjøre#

Manifestet setter opp disse funksjonene. Hver av dem når serveren din via ruten som vises, og fungerer derfor bare når Slack kan nå den ruten.

Bilder i meldinger#

Beskrivelser av hendelser og varsler kan inneholde skjermbilder, for eksempel fra en syntetisk monitor (se Vis et skjermbilde). Status200 viser dem i Slack-meldinger ved å laste opp hvert av dem til arbeidsområdet ditt som en privat fil, noe som krever bot-scopet files:write. Det genererte manifestet inneholder det.

Hvis du opprettet Slack-appen fra et eldre manifest, legger du til files:write under OAuth & Permissions > Bot Token Scopes (eller oppdaterer appen fra det gjeldende manifestet). Velg deretter Connect with Slack igjen under Prosjektinnstillinger > Arbeidsområde > Slack, slik at det nye scopet blir gitt. Inntil da vises hvert skjermbilde som sin alternative tekst.

Vakt-brukergrupper#

Å holde en vaktplans Slack-brukergruppe lik dem som har vakt (se Vakt-brukergrupper) krever bot-scopene usergroups:read og usergroups:write. Det genererte manifestet inneholder dem.

Hvis du opprettet Slack-appen fra et eldre manifest, legger du til usergroups:read og usergroups:write under OAuth & Permissions > Bot Token Scopes (eller oppdaterer appen fra det gjeldende manifestet). Velg deretter Connect with Slack igjen under Prosjektinnstillinger > Arbeidsområde > Slack, slik at de nye scopene blir gitt. Inntil da sier vaktplanens kort at Status200s Slack-app ennå ikke har lov til å endre brukergrupper.

Apper opprettet fra et eldre manifest#

En Slack-app som er opprettet fra et tidligere Status200-manifest, registrerer /incident og /maintenance som egne kommandoer, som kan kollidere med kommandoer med samme navn i andre apper. De virker fortsatt og åpner de samme skjemaene som /status200 incident og /status200 maintenance. For å erstatte dem med /status200 oppdaterer du appen fra manifestet serveren din genererer: på api.slack.com/apps åpner du appens App Manifest, limer inn manifestet og lagrer.

En app som er opprettet før /status200 page, trenger den samme oppdateringen: til den har fått den, kan ikke /status200 page se hvem du nevner med @, og åpner et skjema der du velger dem, i stedet for å tilkalle dem med en gang. Velg deretter Connect with Slack igjen under Prosjektinnstillinger > Arbeidsområde > Slack, slik at scopet users:read.email som manifestet legger til, blir gitt: med det blir en person hvis Slack-konto ikke er koblet til Status200, funnet via e-postadressen sin.

En app som ble opprettet før fanen Home, trenger den samme oppdateringen: til den har den, viser Slack ingen fane Home for appen, og appen publiserer ingen hilsen i en kanal den legges til i. Oppdateringen slår på fanen og abonnerer appen på eventene app_home_opened og member_joined_channel. Den legger ikke til noe scope, så ingenting må kobles til på nytt.

Nettverkstilgang for selvdriftede installasjoner#

Trafikkretning og endepunkter#

De utgående domenene beskriver Status200s Slack-integrasjon, ikke en fullstendig tillatelsesliste for Slack-klienter eller hver Slack-funksjon. En Slack-incoming webhook driftes av Slack: Status200 sender til den, så den er ikke et innkommende endepunkt på serveren din. Se Slacks veiledning for incoming webhooks.

Videresend disse callbackene til Status200 gjennom ingressen:

OAuth er en omdirigering i nettleseren etterfulgt av en tokenutveksling på serveren. Manifestet registrerer /api/slack/auth som prefiks for omdirigerings-URL-en, og Status200 legger til prosjekt- og brukerbanene når den starter autorisasjonen. Tilgang fra nettleseren alene lar ikke Slack levere hendelser eller klikk på knapper.

Private installasjoner og sikkerhet for callbacker#

Bruk offentlig DNS og en gateway med et offentlig klarert HTTPS-sertifikat, en fullstendig sertifikatkjede og en privat rute til Status200-ingressen din. Tillat innkommende TCP 443 til gatewayen, og videresend bare de fire callback-rutene ovenfor. En privat ClusterIP, et internt DNS-navn eller en ansatts VPN-tilkobling kan ikke nås av Slack. Delt DNS kan holde dashbordet og OAuth-rutene private under samme vertsnavn.

Generer manifestet på nytt og oppdater Slack-appen etter en endring av vertsnavnet.

Bevar gjennom gatewayen:

• metoden, banen, spørrestrengen og den opprinnelige bodyen;
• Content-Type, X-Slack-Signature og X-Slack-Request-Timestamp;
• den offentlige verten og HTTPS-skjemaet, via klarerte proxy-headere.

Unnta callback-rutene fra nettleser-SSO, CAPTCHA og proxyens påloggingssider, og behold Status200s kontroller av signing secret og tidsstempel. Hold serverens klokke synkronisert: En forespørsel som avviker med mer enn fem minutter, avvises. Slack dokumenterer verifisering av forespørslers signatur; en kontroll av kilde-IP erstatter den ikke.

Kontroller tilgangen, og forstå begrensningene#

Slack forventer raske bekreftelser, blant annet et svar innen tre sekunder for interaksjoner. En GET fra nettleseren eller en vellykket utgående melding bekrefter ikke disse POST-callbackene.

Innstillingene for tilgang til private nettverk styrer utgående forespørsler til private mål. De gjør ikke callbacker tilgjengelige for Slack.

Feilsøking#

Tilkoblingen ble ikke fullført#

Når Slack sender deg tilbake og tilkoblingen ikke ble opprettet, viser Slack-siden du startet fra (Prosjektinnstillinger > Arbeidsområde > Slack, eller dine egne Brukerinnstillinger > Arbeidsområde > Slack hvis du koblet til kontoen din), Slack ble ikke koblet til, med én setning på språket ditt som sier hvorfor. Resten av siden lastes som vanlig, så du kan koble til på nytt med en gang. Den viser aldri hva Slack selv svarte: Det står i Status200-serverens logg, sammen med årsaken.

Andre problemer#

Neste steg#