Sign inSign up

somosphi/documentation-service

By somosphi

Updated over 6 years ago

Image
0

241

somosphi/documentation-service repository overview

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ávelDescrição
AWS_ACCESS_KEY_IDEspecifica uma chave de acesso da AWS associada a um usuário.
AWS_SECRET_ACCESS_KEYEspecifica a chave secreta associada à chave de acesso.
AWS_REGIONEspecifica a região da AWS para a qual enviar a solicitação.
AWS_BUCKETBucket onde fica localizando a documentação
AWS_SNS_ARNARN do serviço SNS, exemplo: arn:aws:sns:{regiao}:{conta}:{topico}
Opcional
VariávelPadrãoDescrição
AWS_CLOUDFRONT_IDnullID do CloudFront para invaluidação de cache.
CORS_ORIGIN*Configura a origin do CORS.
SNS_LOGfalseHabilita o log das requests do SNS.
PORT3000Porta do serviço.
ROUTE/Prefixo das rotas do serviço.
APM

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

Tag summary

Content type

Image

Digest

Size

46.9 MB

Last updated

over 6 years ago

docker pull somosphi/documentation-service