AppFolio Deploy Integration
Übersicht
Stelle einen containerisierten AppFolio-Immobilienverwaltungs-Integrationsdienst mit Docker bereit. Diese Skill-Anleitung behandelt das Erstellen eines produktionsreifen Images, das eine Verbindung zur AppFolio Stack API für die Verwaltung von Immobilien, Mietern und Arbeitsaufträgen herstellt. Enthalten sind die Umgebungskonfiguration für mehrere Immobilien, Health-Checks, die die API-Konnektivität überprüfen, sowie Strategien für rollierende Updates mit null Ausfallzeiten im gesamten Immobilienportfolio.
Voraussetzungen
- Ein verifizierter Providervertrag und ein geheimer, vertragsgebundener AppFolio-Client, der über einen Secret-Manager gesichert ist. Geben Sie keine Anmeldeinformationen in Image-Ebenen, Compose-Dateien, Shell-Verlauf oder Bereitstellungsprotokolle ein.
- Eine Bereitstellungsplattform, die echte rollierende/Canary-Updates mit Readiness-Checks, Traffic-Steuerung, Rollback und einem benannten Freigabe-Inhaber durchführen kann.
- Getrennte Staging- und Produktionsidentitäten, ein synthetisches Staging-Smoke-Test-Fixture und ein Incident-Plan für unbekannte Schreib- oder Abgleichszustände.
Anleitung
- Erstellen Sie ein Non-Root-Image mit gesperrten Abhängigkeiten und legen Sie nur einen lokalen Liveness-Endpunkt frei. Die Provider-Verfügbarkeit gehört zur Readiness, nicht zum Prozess-Überleben.
- Injizieren Sie die verifizierte Client-Konfiguration zur Laufzeit aus dem Secret-Manager und validieren Sie deren Vertrag im Staging durch einen autorisierten sicheren Lesevorgang.
- Führen Sie eine neue Revision schrittweise aus, überwachen Sie geschwärzte Readiness-/Fehlersignale und behalten Sie die vorherige Revision bei, bis das Traffic-Fenster erfolgreich ist.
- Stoppen Sie bei fehlgeschlagenen Readiness-, Vertrags-, Secret- oder Abgleichsprüfungen die Traffic-Förderung und führen Sie ein Rollback über die Bereitstellungsplattform durch.
Docker-Konfiguration
FROM node:20-slim AS builder
WORKDIR /app
COPY package*.json ./
RUN npm ci
COPY tsconfig.json ./
COPY src/ ./src/
RUN npm run build
FROM node:20-slim
RUN addgroup --system app && adduser --system --ingroup app app
WORKDIR /app
COPY --from=builder /app/dist ./dist
COPY --from=builder /app/node_modules ./node_modules
COPY package*.json ./
USER app
EXPOSE 3000
HEALTHCHECK --interval=30s --timeout=5s --retries=3 \
CMD node -e "fetch('http://127.0.0.1:3000/health').then(r => process.exit(r.ok ? 0 : 1)).catch(() => process.exit(1))"
CMD ["node", "dist/index.js"]
Laufzeitkonfiguration
# Werte werden vom Secret-Manager der Bereitstellungsplattform injiziert; geben Sie keine
# Live-Anmeldeinformationen in ein Terminalkommando oder eine eingecheckte Konfiguration ein.
APPFOLIO_BASE_URL="Provider-ausgestellte Basis-URL"
APPFOLIO_COMPANY_ID="genehmigte Portfolio-Kennung"
export LOG_LEVEL="info"
export PORT="3000"
export NODE_ENV="production"
Health-Check-Endpunkt
import express from 'express';
const app = express();
// Liveness beweist, dass dieser Prozess bedienen kann; er darf einen gesunden Worker nicht neu starten,
// nur weil der externe Provider beeinträchtigt ist.
app.get('/health', (_req, res) => {
res.json({ status: 'healthy', service: 'appfolio-integration' });
});
app.get('/ready', async (_req, res) => {
try {
const response = await createVerifiedAppFolioClient().get('/properties?limit=1');
if (response.status < 200 || response.status >= 300) throw new Error(`AppFolio API returned ${response.status}`);
res.json({ status: 'ready', service: 'appfolio-integration', timestamp: new Date().toISOString() });
} catch (error) {
res.status(503).json({ status: 'not-ready', error: 'provider readiness check failed' });
}
});
Bereitstellungsschritte
Schritt 1: Bauen
docker build -t appfolio-integration:latest .
Schritt 2: Ausführen
docker run -d --name appfolio-integration \
-p 3000:3000 \
-e APPFOLIO_API_KEY -e APPFOLIO_BASE_URL -e APPFOLIO_COMPANY_ID \
appfolio-integration:latest
Schritt 3: Überprüfen
curl -s http://localhost:3000/health | jq .
Schritt 4: Rollierendes Update
# Übermitteln Sie den unveränderlichen Image-Digest an den Bereitstellungscontroller der Plattform.
# Konfigurieren Sie /health als Liveness und /ready als Readiness, verschieben Sie den Traffic
# in Stufen und behalten Sie die vorherige Revision bei, bis das Release-Fenster abgeschlossen ist.
Fehlerbehandlung
| Problem | Ursache | Behebung |
|---|---|---|
401 Unauthorized | Ungültiger oder abgelaufener API-Schlüssel | Schlüssel im AppFolio Stack Partner-Portal neu generieren |
403 Forbidden | Fehlender Zugriffsbereich für Immobilien | Zusätzliche Bereiche vom AppFolio-Administrator anfordern |
404 Not Found | Falsche Basis-URL oder Unternehmens-ID | Überprüfen, ob APPFOLIO_BASE_URL mit Ihrer Subdomain übereinstimmt |
429 Rate Limited | Zu viele Anfragen pro Minute | Exponentielles Backoff mit 60-Sekunden-Fenster implementieren |
| Container wird sofort beendet | Fehlende erforderliche Umgebungsvariablen | Stellen Sie sicher, dass alle Umgebungsvariablen vor dem Start gesetzt sind |
Ausgabe
- Ein Non-Root-Container mit einem lokalen Liveness-Endpunkt und einem separaten, geschwärzten Provider-Readiness-Ergebnis
- Eine Secret-Manager/Laufzeitkonfigurationsgrenze anstelle von Anmeldeinformationen in Images oder Befehlen
- Ein gestaffelter Bereitstellungsbeleg mit Readiness-Nachweis, Traffic-Status, Inhaber, Rollback-Ziel und Abgleichszustand
Beispiele
Für ein Property-Sync-Release stellen Sie das neue Image im Staging mit einem synthetischen Safe-Read-Fixture bereit und bestätigen, dass /health live bleibt, während /ready das Provider-Client-Ergebnis widerspiegelt. Fördern Sie einen kleinen Produktions-Traffic-Slice erst, nachdem die verwaltete Identität, geschwärzte Readiness, Alarme und das Rollback-Ziel überprüft wurden. Wenn die Readiness fehlschlägt, ein Secret fehlt oder ein vorheriger Schreibvorgang ein unbekanntes Ergebnis hat, stoppen Sie die Förderung, leiten Sie den Traffic zur vorherigen Revision zurück und weisen Sie den Abgleich zu, bevor Sie einen weiteren Rollout versuchen.
Ressourcen
Nächste Schritte
Siehe appfolio-webhooks-events.