Platform Engineering e Internal Developer Platforms¶

# Exemplo: Entidade no Backstage Software Catalog
apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  name: api-pagamentos
  description: API de processamento de pagamentos
  tags:
    - python
    - fastapi
    - payments
  annotations:
    github.com/project-slug: empresa/api-pagamentos
    backstage.io/techdocs-ref: dir:.
spec:
  type: service
  lifecycle: production
  owner: squad-payments
  system: plataforma-pagamentos
  dependsOn:
    - resource:postgres-prod
    - resource:kafka-cluster
  providesApis:
    - api-pagamentos-rest

# Exemplo: Template de serviço (Backstage)
apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
  name: microservico-python
  title: Novo Microserviço Python
  description: Cria um novo serviço FastAPI com CI/CD
spec:
  owner: platform-team
  type: service
  parameters:
    - title: Informações do Serviço
      required:
        - name
        - owner
      properties:
        name:
          title: Nome do Serviço
          type: string
          description: Nome único do serviço
        owner:
          title: Squad Responsável
          type: string
          ui:field: OwnerPicker
  steps:
    - id: fetch-template
      name: Fetch Template
      action: fetch:template
      input:
        url: ./template
        values:
          name: ${{ parameters.name }}
          owner: ${{ parameters.owner }}

    - id: publish
      name: Publish to GitHub
      action: publish:github
      input:
        allowedHosts: ['github.com']
        description: Microserviço ${{ parameters.name }}
        repoUrl: github.com?owner=empresa&repo=${{ parameters.name }}

    - id: register
      name: Register Component
      action: catalog:register
      input:
        repoContentsUrl: ${{ steps.publish.output.repoContentsUrl }}
        catalogInfoPath: '/catalog-info.yaml'
  output:
    links:
      - title: Repository
        url: ${{ steps.publish.output.remoteUrl }}
      - title: Open in Catalog
n        icon: catalog
        entityRef: ${{ steps.register.output.entityRef }}

# Exemplo: Definição de Golden Path
apiVersion: platform.company.io/v1
kind: GoldenPath
metadata:
  name: web-service-python
spec:
  description: Serviço web Python com FastAPI
  runtime: python:3.11
  framework: fastapi:0.104

  requiredPatterns:
    - observability:
        tracing: opentelemetry
        metrics: prometheus
        logging: structured-json
    - security:
        authentication: oauth2-jwt
        secrets: vault
        scan: trivy-snyk
    - deployment:
        strategy: canary
        platform: kubernetes
        gitops: argocd
    - database:
        migrations: alembic
        pooling: pgbouncer

  optionalPatterns:
    - caching:
        provider: redis
    - messaging:
        provider: kafka
    - feature_flags:
        provider: unleash

# Componentes essenciais do MVP
mvp:
  networking:
    - cni: cilium  # ou calico
    - ingress: nginx ou traefik
    - service_mesh: linkerd (opcional)

  security:
    - pod_security: restricted
    - network_policies: default-deny
    - rbac: principle of least privilege
    - secrets: external-secrets-operator

  observability:
    - metrics: prometheus + grafana
    - logs: loki ou fluentd
    - traces: jaeger ou tempo
    - alerts: alertmanager

  gitops:
    - controller: argocd ou flux
    - image_automation: habilitado

# Política de ciclo de vida de imagens
imageLifecycle:
  build:
    - multi_stage: true
    - distroless: preferred
    - scan_on_build: true

  registry:
    - provider: ecr ou gcr
    - retention: 30 dias para dev, 90 para prod
    - immutability: enabled

  deployment:
    - tag_strategy: semver
    - pull_policy: IfNotPresent
    - verify_signature: true

# Ferramentas de inner loop
innerLoop:
  local_development:
    - tilt: hot reload
    - telepresence: remote cluster dev
    - devcontainers: vscode

  testing:
    - unit: pytest/jest
    - integration: testcontainers
    - contract: pact

  feedback:
    - lint: pre-commit hooks
    - type_check: mypy/typescript
    - security: trivy local

# Outer loop - CI/CD e operações
outerLoop:
  ci:
    - platform: github-actions ou gitlab-ci
    - parallel_jobs: true
    - caching: aggressive

  cd:
    - strategy: gitops
    - progressive_delivery: argo-rollouts
    - automated_rollback: true

  operations:
    - observability: unified platform
    - alerting: pagerduty ou opsgenie
    - runbooks: backstage techdocs

# Dashboard de métricas do IDP
platformMetrics:
  adoption:
    - services_on_platform: 45/50 (90%)
    - active_users: 120/150 (80%)
    - template_usage: 15/week
    - self_service_rate: 95%

  developer_experience:
    - time_to_first_deploy: 2 days (meta: 1 dia)
    - developer_satisfaction: 4.2/5.0
    - support_tickets: -40% YoY
    - cognitive_load_score: "baixo"

  platform_health:
    - platform_uptime: 99.99%
    - template_success_rate: 98%
    - mean_time_to_template_update: 3 days
    - security_compliance: 96%

# Exemplo: Integração de IA no portal
aiAssistant:
  capabilities:
    - code_generation:
        context: "Gerar código baseado em templates da org"
        example: "Criar endpoint REST para CRUD de usuários"

    - documentation:
        context: "TechDocs existentes"
        example: "Como configurar autenticação OAuth?"

    - troubleshooting:
        context: "Logs, métricas, runbooks"
        example: "Por que meu serviço está com alta latência?"

    - optimization:
        context: "Custos cloud, performance"
        example: "Como reduzir custos do meu serviço?"