Giter Club home page Giter Club logo

documentation-service's Introduction

Documentation Service

Permissões

IAM de leitura

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "s3:GetObject",
        "sns:ConfirmSubscription",
        "sns:Unsubscribe",
        "s3:ListBucket",
        "cloudfront:CreateInvalidation"
      ],
      "Resource": [
        "arn:aws:sns:{regiao}:{conta}:{topico}",
        "arn:aws:s3:::{bucket}",
        "arn:aws:s3:::{bucket}/*",
        "arn:aws:cloudfront::*:distribution/{distributionId}"
      ]
    }
  ]
}

IAM de escrita

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "s3:PutObject",
        "s3:AbortMultipartUpload",
        "s3:ListBucket",
        "s3:DeleteObject",
        "s3:GetObjectVersion",
        "s3:ListMultipartUploadParts"
      ],
      "Resource": [
        "arn:aws:s3:::{bucket}",
        "arn:aws:s3:::{bucket}/*"
      ]
    }
  ]
}

SNS

Política de acesso do serviço SNS

{
  "Version": "2008-10-17",
  "Id": "__default_policy_ID",
  "Statement": [
    {
      "Sid": "__default_statement_ID",
      "Effect": "Allow",
      "Principal": {
        "AWS": "*"
      },
      "Action": "SNS:Publish",
      "Resource": "arn:aws:sns:{regiao}:{conta}:{topico}",
      "Condition": {
        "ArnLike": {
          "aws:SourceArn": "arn:aws:s3:*:*:{bucket}"
        }
      }
    }
  ]
}

Variáveis de Ambiente

Requerido

Variável Descrição
AWS_ACCESS_KEY_ID Especifica uma chave de acesso da AWS associada a um usuário.
AWS_SECRET_ACCESS_KEY Especifica a chave secreta associada à chave de acesso.
AWS_REGION Especifica a região da AWS para a qual enviar a solicitação.
AWS_BUCKET Bucket onde fica localizando a documentação
AWS_SNS_ARN ARN do serviço SNS, exemplo: arn:aws:sns:{regiao}:{conta}:{topico}

Opcional

Variável Padrão Descrição
AWS_CLOUDFRONT_ID null ID do CloudFront para invaluidação de cache.
CORS_ORIGIN * Configura a origin do CORS.
SNS_LOG false Habilita o log das requests do SNS.
PORT 3000 Porta do serviço.
ROUTE / Prefixo das rotas do serviço.

APM

REF: APM Node.js Agent Reference

Para ativar o APM é necessário configurar no mínimo a variável ELASTIC_APM_SERVICE_NAME.

documentation-service's People

Contributors

henrique502 avatar

Watchers

James Cloos avatar Yuri Gossmann avatar Thales Correa avatar gmenti avatar Ciro Stodulski de Azevedo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.