Slack-integration

Forbind din selvhostede Status200 med Slack. Du opretter en Slack-app ud fra det manifest, din server genererer, giver Status200 appens legitimationsoplysninger og forbinder hvert projekt med et arbejdsområde. Derefter poster Status200 hændelser, alarmer og planlagt vedligeholdelse i dine kanaler, og dit team handler på dem fra Slack.

Denne side er til den, der driver Status200-serveren. Når Slack er forbundet, opsættes notifikationsregler pr. projekt: se Slack.

Sådan fungerer det#

Slack-appen er din egen: Den er installeret i dit arbejdsområde og taler kun med din server. Trafikken går begge veje, og hver retning kræver sin egen netværksadgang.

• Udgående: Status200 kalder Slacks Web API for at poste beskeder, oprette kanaler og uploade billeder.
• Indgående: Slack kalder fire ruter på din server for events, klik på knapper, menuer og slash-kommandoer. Hver anmodning er signeret med appens signing secret. Status200 afviser en anmodning, hvis signatur ikke passer, eller hvis tidsstempel er mere end fem minutter gammelt.

Før du begynder#

• Et Slack-arbejdsområde, hvor du kan oprette og installere apps.
• Et offentligt HTTPS-værtsnavn til Status200, som Slack kan nå. Se Netværksadgang.
• Adgang til serverens konfiguration: config.env til Docker Compose eller dine Helm-values til Kubernetes.
• For at forbinde et projekt: rollen Project Owner, Project Admin eller Project Member i det.

Opsæt Slack-appen#

1. Angiv den offentlige URL#

   Status200 bygger appmanifestet og hver callback-URL ud fra HOST og HTTP_PROTOCOL. Sæt dem til det værtsnavn, Slack skal kalde, 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 værdier genererer kun URL'er. De opretter ikke DNS-poster, certifikater eller firewallregler.

2. Kopiér appmanifestet#

   Åbn Projektindstillinger > Arbejdsområde > Slack. Indtil Slack er sat op på serveren, viser siden Integrating Slack with your Status200 Project med det manifest, der er genereret til dit værtsnavn. Det serveres også på https://status200.example.com/api/slack/app-manifest.

   Kontrollér, at hver URL i manifestet begynder med dit offentlige værtsnavn. Hvis ikke, så ret først HOST og HTTP_PROTOCOL, og anvend ændringen.

3. Opret Slack-appen#

   Opret på api.slack.com/apps en ny app ud fra et manifest, vælg dit arbejdsområde, og indsæt manifestet. Brug altid det manifest, din egen server genererer, så dets URL'er passer til dit værtsnavn.

4. Kopiér appens legitimationsoplysninger#

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

5. Tilføj legitimationsoplysningerne 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 at holde værdierne i en Kubernetes-Secret, som du selv administrerer, angiver du i stedet slackApp.existingSecret: dens name og nøglerne clientIdKey, clientSecretKey og signingSecretKey.

6. Anvend konfigurationen#

   Docker ComposeKubernetes

   Docker Compose

   Bash

   npm run start

   Det genopretter containerne med den nye config.env. docker compose restart læser den ikke igen.

   Kubernetes

   Bash

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

   Når Status200 kører igen, viser Projektindstillinger > Arbejdsområde > Slack en knap Connect with Slack i stedet for manifestet.

7. Bekræft request-URL'en til events#

   Bekræft request-URL'en under Event Subscriptions i Slack-appen. Status200 besvarer først Slacks challenge, når signing secret er angivet, så prøv igen, hvis det mislykkedes, mens du oprettede appen.

8. Forbind projektet#

   Vælg Connect with Slack under Projektindstillinger > Arbejdsområde > Slack, og tillad appen i Slack. Slack sender dig tilbage til samme side, som nu viser dit arbejdsområde.

9. Forbind din egen Slack-konto#

   Knapper, formularer og kommandoer handler som den Status200-bruger, der er knyttet til den Slack-konto, der bruger dem. Hver person åbner Brugerindstillinger > Arbejdsområde > Slack og vælger Connect my account with Slack. Den, der ikke har forbundet en konto, får der, hvor vedkommende trykkede, et svar med en knap Connect Slack account, der forbinder den i ét trin.

Miljøvariabler#

Hvad appen kan#

Manifestet opsætter disse funktioner. Hver af dem når din server via den viste rute og virker derfor kun, når Slack kan nå den rute.

Billeder i beskeder#

Beskrivelser af hændelser og alarmer kan indeholde skærmbilleder, for eksempel fra en syntetisk monitor (se Vis et skærmbillede). Status200 viser dem i Slack-beskeder ved at uploade hvert enkelt til dit arbejdsområde som en privat fil, hvilket kræver bot-scopet files:write. Det genererede manifest indeholder det.

Hvis du har oprettet din Slack-app ud fra et ældre manifest, så tilføj files:write under OAuth & Permissions > Bot Token Scopes (eller opdatér appen ud fra det aktuelle manifest). Vælg derefter Connect with Slack igen under Projektindstillinger > Arbejdsområde > Slack, så det nye scope bliver givet. Indtil da vises hvert skærmbillede som sin alternative tekst.

Vagt-brugergrupper#

At holde en vagtplans Slack-brugergruppe lig med dem, der har vagt (se Vagt-brugergrupper), kræver bot-scopes usergroups:read og usergroups:write. Det genererede manifest indeholder dem.

Hvis du har oprettet din Slack-app ud fra et ældre manifest, så tilføj usergroups:read og usergroups:write under OAuth & Permissions > Bot Token Scopes (eller opdatér appen ud fra det aktuelle manifest). Vælg derefter Connect with Slack igen under Projektindstillinger > Arbejdsområde > Slack, så de nye scopes bliver givet. Indtil da siger vagtplanens kort, at Status200s Slack-app endnu ikke må ændre brugergrupper.

Apps oprettet ud fra et ældre manifest#

En Slack-app, der er oprettet ud fra et tidligere Status200-manifest, registrerer /incident og /maintenance som egne kommandoer, og de kan støde sammen med andre apps' kommandoer med samme navn. De virker stadig og åbner de samme formularer som /status200 incident og /status200 maintenance. For at erstatte dem med /status200 skal du opdatere appen ud fra det manifest, din server genererer: på api.slack.com/apps åbner du appens App Manifest, indsætter manifestet og gemmer.

En app, der er oprettet før /status200 page, skal have den samme opdatering: indtil den har fået den, kan /status200 page ikke se, hvem du nævner med @, og åbner en formular, hvor du vælger dem, i stedet for at tilkalde dem med det samme. Vælg derefter Connect with Slack igen under Projektindstillinger > Arbejdsområde > Slack, så det users:read.email-scope, manifestet tilføjer, bliver givet: med det findes en person, hvis Slack-konto ikke er forbundet med Status200, på sin e-mailadresse.

En app, der er oprettet før fanen Home, har brug for den samme opdatering: indtil den har den, viser Slack ingen fane Home for appen, og appen slår ingen hilsen op i en kanal, den tilføjes til. Opdateringen slår fanen til og abonnerer appen på begivenhederne app_home_opened og member_joined_channel. Den tilføjer intet scope, så intet skal forbindes igen.

Netværksadgang for selvhostede installationer#

Trafikretning og endpoints#

De udgående domæner beskriver Status200s Slack-integration, ikke en fuldstændig tilladelsesliste for Slack-klienter eller hver Slack-funktion. En Slack-incoming webhook hostes af Slack: Status200 sender til den, så den er ikke et indgående endpoint på din server. Se Slacks vejledning til incoming webhooks.

Videresend disse callbacks til Status200 gennem dens ingress:

OAuth er en omdirigering i browseren efterfulgt af en tokenudveksling på serveren. Manifestet registrerer /api/slack/auth som præfiks for omdirigerings-URL'en, og Status200 tilføjer projekt- og brugerstierne, når den starter autorisationen. Adgang fra browseren alene lader ikke Slack levere events eller klik på knapper.

Private installationer og sikkerhed for callbacks#

Brug offentlig DNS og en gateway med et offentligt betroet HTTPS-certifikat, en komplet certifikatkæde og en privat rute til din Status200-ingress. Tillad indgående TCP 443 til gatewayen, og videresend kun de fire callback-ruter ovenfor. En privat ClusterIP, et internt DNS-navn eller en medarbejders VPN-forbindelse kan Slack ikke nå. Split DNS kan holde dashboardet og OAuth-ruterne private under samme værtsnavn.

Generér manifestet igen, og opdatér Slack-appen efter en ændring af værtsnavnet.

Bevar gennem gatewayen:

• metoden, stien, forespørgselsstrengen og den oprindelige body;
• Content-Type, X-Slack-Signature og X-Slack-Request-Timestamp;
• den offentlige vært og HTTPS-skemaet, via betroede proxyheadere.

Undtag callback-ruterne fra browser-SSO, CAPTCHA og proxyens loginsider, og behold Status200s kontrol af signing secret og tidsstempel. Hold serverens ur synkroniseret: En anmodning, der afviger mere end fem minutter, afvises. Slack dokumenterer verificering af anmodningers signatur; en kontrol af kilde-IP erstatter den ikke.

Kontrollér adgangen, og forstå begrænsningerne#

Slack forventer hurtige kvitteringer, herunder et svar inden for tre sekunder ved interaktioner. Et GET fra browseren eller en udgående besked, der lykkes, bekræfter ikke disse POST-callbacks.

Indstillingerne for adgang til private netværk styrer udgående anmodninger til private destinationer. De gør ikke callbacks tilgængelige for Slack.

Fejlfinding#

Forbindelsen blev ikke fuldført#

Når Slack sender dig tilbage, og forbindelsen ikke blev oprettet, viser den Slack-side, du startede fra (Projektindstillinger > Arbejdsområde > Slack, eller dine egne Brugerindstillinger > Arbejdsområde > Slack, hvis du forbandt din konto), Slack blev ikke forbundet med én sætning på dit sprog, der siger hvorfor. Resten af siden indlæses som normalt, så du kan forbinde igen lige dér. Den viser aldrig, hvad Slack selv svarede: Det står i Status200-serverens log sammen med årsagen.

Andre problemer#

Næste trin#