diff --git a/docs.en-us/articles/rest-pki/core/on-premises/azure/index.md b/docs.en-us/articles/rest-pki/core/on-premises/azure/index.md new file mode 100644 index 00000000..3236fe0e --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/on-premises/azure/index.md @@ -0,0 +1,16 @@ +# Rest PKI Core - Setup on Azure App Services + + +
+ + diff --git a/docs.en-us/articles/rest-pki/core/on-premises/azure/install.md b/docs.en-us/articles/rest-pki/core/on-premises/azure/install.md new file mode 100644 index 00000000..ad04556f --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/on-premises/azure/install.md @@ -0,0 +1,9 @@ +# Installing Rest PKI Core on Azure App Services + + +
+ +## See also + +* [Updating Rest PKI Core on Azure App Services](update.md) +* [Troubleshooting](troubleshoot/index.md) diff --git a/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/check-logs.md b/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/check-logs.md new file mode 100644 index 00000000..ec3e8740 --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/check-logs.md @@ -0,0 +1,9 @@ +# Rest PKI Core - Checking the system logs (Azure App Services) + +The standard location on table of the system log is `AppLogs` of **Azure Storage** account, created for the system on the installation moment. + +To check which account and table are being used, go to **App Services** > (select the app service) > **Configuration** and check the value of the settings `Serilog:WriteTo:0:Args:connectionString` and `Serilog:WriteTo:0:Args:storageTableName`. + +> [!NOTE] +> Some errors, usually those that occur during system startup, may not be logged in the system log file. +> To diagnose such errors, see [Troubleshooting startup errors](startup-errors.md). \ No newline at end of file diff --git a/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/index.md b/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/index.md new file mode 100644 index 00000000..b4a3ba01 --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/index.md @@ -0,0 +1,14 @@ +# Troubleshooting issues on your Rest PKI Core instance (Azure App Services) + +Common issues: + +* *HTTP Error 500.30 - ANCM In-Process Start Failure* upon accessing the website - see [Troubleshooting startup errors](startup-errors.md) +* *HTTP Error 502.5 - ANCM Out-Of-Process Startup Failure* upon accessing the website - see [Troubleshooting startup errors](startup-errors.md) + +> [!NOTE] +> If the issue you are encountering is not listed here, try [checking the system logs](check-logs.md) or contact us. + +## See also + +* [Checking the system logs](check-logs.md) +* [Troubleshooting startup errors](startup-errors.md) diff --git a/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/startup-errors.md b/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/startup-errors.md new file mode 100644 index 00000000..d2f506f6 --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/on-premises/azure/troubleshoot/startup-errors.md @@ -0,0 +1,42 @@ +# Troubleshooting startup errors (Azure App Services) + +Upon starting up your [on-premises instance](../../index.md) of [Rest PKI Core](../../../index.md) hosted on [Azure App Services](../index.md), you might encounter one +of the following errors: + +* *HTTP Error 500.30 - ANCM In-Process Start Failure* +* *HTTP Error 502.5 - ANCM Out-Of-Process Startup Failure* + +In either case, follow the steps below to enable the startup logs. + +## Enabling startup logs + +Access the App Service's files through FTP, navigate to the folder */site/wwwroot* and and copy the *web.config* file over to your computer. + +Then, change the `aspNetCore` element, setting the `stdoutLogEnabled` attribute to `true`. + +For instance, suppose the `aspNetCore` element is initially as follows: + +```xml + +``` + +After changing the `stdoutLogEnabled` attribute to `true`, it would then look like: + +```xml + +``` + +Also confirm that the attribute `stdoutLogFile` has the value `.\logs\stdout` as above. + +Copy the *web.config* file back to the App Service's folder */site/wwwroot*, replacing the old file. + +Wait a few seconds and attempt to access the site again, then refresh the App Service's files on your FTP access. There should be a new folder called *logs*. Navigate +into it and inspect the files. They should reveal the cause of the error. + +> [!WARNING] +> Remember to set the `stdoutLogEnabled` attribute back to `false` once your diagnostic is complete, since this will generate a large amount of log data and might +> impair performance. + +## See also + +* [Troubleshooting issues on your Rest PKI Core instance](index.md) diff --git a/docs.en-us/articles/rest-pki/core/on-premises/azure/update.md b/docs.en-us/articles/rest-pki/core/on-premises/azure/update.md new file mode 100644 index 00000000..b5639c5e --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/on-premises/azure/update.md @@ -0,0 +1,9 @@ +# Updating Rest PKI Core on Azure App Services + + +
+ +## See also + +* [Installing Rest PKI Core on Azure App Services](install.md) +* [Troubleshooting](troubleshoot/index.md) diff --git a/docs.en-us/articles/rest-pki/core/on-premises/configure-https-redirect.md b/docs.en-us/articles/rest-pki/core/on-premises/configure-https-redirect.md new file mode 100644 index 00000000..676e24d4 --- /dev/null +++ b/docs.en-us/articles/rest-pki/core/on-premises/configure-https-redirect.md @@ -0,0 +1,13 @@ +# Configure HTTPS redirection - Rest PKI Core + +If you have a valid SSL certificate for your [Rest PKI](../index.md) [on-premises instance](index.md) +and have enabled SSL, you may want to redirect users reaching your instance through HTTP to the HTTPS endpoint. + +To enable HTTPS redirection, change the section **Bindings** of the configuration file: + +* **HttpsMode**: set to `RedirectPages` +* **SslPort**: if your HTTPS endpoint is not on port 443, set the port here + +## See also + +* [Rest PKI on-premises](index.md) diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/add-custom-domain.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/add-custom-domain.md new file mode 100644 index 00000000..4e6b7b05 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/add-custom-domain.md @@ -0,0 +1,7 @@ +1. De volta às configurações do App Service, clique em **Custom domains** +1. Clique em **+ Add custom domain** +1. Selecione **All other domain services** +1. Deixe selecionadas as opções **App Service Managed Certificate** e **SNI SSL** +1. Em *Domain*, preencha o domínio (ex: `app.patorum.com`) +1. Clique em **Validate** +1. Após a validação, clique em **Add** diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-acr.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-acr.md new file mode 100644 index 00000000..49cea3ef --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-acr.md @@ -0,0 +1,10 @@ +## Criação de um *Container registry* + +Siga os procedimentos abaixo para criar um *container registry* para armazenar localmente uma cópia das imagens de Docker do sistema: + +1. Na opção **Container registries**, clique em **+ Create** +1. Na primeira aba (*Basics*) + * Preencha os dados conforme a sua infraestrutura (seguindo a região escolhida para o sistema) + * Tome nota do *registry name* escolhido + * Em *SKU*, escolha **Basic** +1. Clique em **Review + create**, em seguida em **Create** diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-database.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-database.md new file mode 100644 index 00000000..e03b60bc --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-database.md @@ -0,0 +1,21 @@ +## Criação do banco de dados + +Siga os procedimentos abaixo para criar um banco de dados para o sistema (você precisa ter um *SQL Server* previamente criado): + +1. Na opção **SQL databases**, clique em **+ Create** +1. Na primeira aba (*Basics*), preencha os dados conforme a sua infraestrutura (seguindo a região escolhida para o sistema) +1. Clique na aba **Additional settings** +1. Em **Collation** preencha `Latin1_General_100_CI_AI` +1. Clique em **Review + create** +1. Clique em **Create** + +> [!WARNING] +> A *collation* do banco de dados **PRECISA SER** `Latin1_General_100_CI_AI`. Criar o banco de dados com uma *collation* diferente provavelmente fará com que a instalação falhe! + +Uma vez concluida a criação do banco de dados, clique em **Go to resource**. Em seguida, obtenha a *connection string*: + +1. Clique em **Connection strings** +1. Tome nota da connection string exibida na seção **ADO.NET (SQL authentication)** + +> [!NOTE] +> Substitua na connection string copiada o trecho `{your_password}` pela senha do banco de dados diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-dns-record.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-dns-record.md new file mode 100644 index 00000000..93c26ff3 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-dns-record.md @@ -0,0 +1,18 @@ +> [!NOTE] +> Nas instruções abaixo, utilizaremos como exemplo a criação do apontamento para o domínio `app.patorum.com` + +1. Em **DNS zones**, clique na zona à qual o domínio pertence (ex: `patorum.com`) +1. Clique em **+ Record set** +1. Em *Name*, digite a porção mais à esquerda do domínio (ex: `app`) +1. Em *Type*, selecione **CNAME** +1. Em *Alias record set*, selecione **No** +1. Em *Alias*, preencha o domínio do App Service (ex: `meu-app-service.azurewebsites.net`) +1. Clique em **OK** +1. Clique novamente em **+ Record set** +1. Em *Name*, digite `asuid.` seguido da porção mais à esquerda do domínio (ex: `asuid.app`) +1. Em *Type*, selecione **TXT** +1. Em *Value*, cole o valor do **Custom Domain Verification ID** anteriormente copiado do App Service +1. Clique em **OK** + +> [!NOTE] +> Caso você não utilize o Azure como servidor de DNS das zonas, realize o procedimento equivalente no seu servidor de DNS diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-storage.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-storage.md new file mode 100644 index 00000000..1a883c83 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-storage.md @@ -0,0 +1,17 @@ +## Criação de uma *storage account* + +Precisamos de uma *storage account* para armazenar arquivos (o sistema armazena arquivos fora do banco de dados para mantê-lo organizado) e também os +logs de sistema. Siga os passos abaixo para criar uma *storage account* (caso queira utilizar uma conta existente, pule essa parte): + +1. Em **Storage accounts**, clique em **+ Create** +1. Na primeira aba (*Basics*), preencha os dados conforme a sua infraestrutura (seguindo a região escolhida para o sistema) + * Em *Performance*, escolha **Standard** + * Em *Redundancy*, escolha a opção que preferir (sugerimos a opção **Zone-redundant storage (ZRS)** -- clique aqui + para detalhes sobre as diferentes opções de replicação) +1. Clique em **Review** +1. Clique em **Create** + +Uma vez concluída a criação da *storage account*, clique em **Go to resource**. Em seguida, obtenha uma *connection string*: + +1. Nas configurações da *storage acount*, clique em **Access keys** +1. Na seção **key1**, tome nota do valor do campo **Connection string** diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-webapp-docker.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-webapp-docker.md new file mode 100644 index 00000000..69e2333c --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/create-webapp-docker.md @@ -0,0 +1,33 @@ +## Criação do App Service + +Siga os procedimentos abaixo para criar um *App Service* (você precisa ter um *App Service Plan* previamente criado com sistema operacional **Linux**): + +1. Em **App Services**, clique em **+ Create** em seguida em **+ Web App** +1. Na primeira aba (*Basics*), preencha os dados conforme a sua infraestrutura (seguindo a região escolhida para o sistema) + * Em *Publish*, escolha **Docker Container** + * Em *Operating System*, escolha **Linux** + * Em *Region*, escolha a região onde está o seu *app service plan* + * Em *Linux Plan* , escolha o seu *app service plan* + * Clique em **Next : Docker >** +1. Na aba seguinte (*Docker*), preencha: + * Em *Options*, deixe a opção **Single Container** + * Em *Image Source*, selecione **Azure Container Registry** + * Em *Registry*, selecione o *container registry* criado anteriormente + * Em *Image* e *Tag*, selecione a imagem/tag do sistema conforme o comando `az acr import` realizado anteriormente + * Deixe a opção *Startup Command* **em branco** + * Clique em **Review + create** +1. Clique em **Create** + +Uma vez concluída a criação do App Service, clique em **Go to resource**. Em seguida, tome nota de seu domínio, por exemplo `meu-app-service.azurewebsites.net`. + +Vá em **Configuration** do App Service e adicione as seguintes configurações: + +* `ASPNETCORE_ENVIRONMENT`: `Azure` +* `Bindings__HttpsMode`: `Strict` +* `STANDBY`: `True` + +Salve as configurações. + +Ainda na configuração do App Service, vá na aba **General settings** e, na opção **HTTPS Only**, marque **Off** (a própria aplicação se encarregará de exigir acesso via HTTPS da maneira mais adequada). + +Em seguida, vá em **Custom domains** e copie o **Custom Domain Verification ID** (esse valor será necessário mais à frente). diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/optional-settings.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/optional-settings.md new file mode 100644 index 00000000..73a89d4a --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/optional-settings.md @@ -0,0 +1,8 @@ +### Configurações opcionais + +Recomendamos não alterar essas configurações por ora. Uma vez que a sua instância do Rest PKI Core esteja no ar, você +pode visitar cada um dos links abaixo para habilitar funcionalidades opcionais: + +* [Redirecionamento para HTTPS](../../configure-https-redirect.md) +* [Envio de emails](../../configure-email.md) +* [Integração com OpenID Connect](../../configure-oidc.md) (necessário para gerenciamento de usuários) diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/prep-recommendations.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/prep-recommendations.md new file mode 100644 index 00000000..f3f23a9f --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/prep-recommendations.md @@ -0,0 +1,6 @@ +Sugerimos criar um **resource group** para agrupar os recursos criados. Entretanto, essa é uma medida com propósito meramente de organização. O que +realmente é importante é que **todos os recursos sejam criados na mesma região**. Isso é fundamental para o funcionamento adequado do sistema. + +> [!NOTE] +> Os passos abaixo descrevem a criação mais básica de cada recurso. Dependendo da sua infraestrutura você pode querer tomar cuidados +> adicionais de segurança ou resiliência, como por exemplo restringir o acesso a uma rede privada. diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/see-planning.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/see-planning.md new file mode 100644 index 00000000..ece4e1a4 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/includes/see-planning.md @@ -0,0 +1,2 @@ +> [!TIP] +> Antes de começar, leia a seção [Planejamento antes da instalação](../index.md#planning). diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/index.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/index.md new file mode 100644 index 00000000..173378de --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/index.md @@ -0,0 +1,11 @@ +# Rest PKI Core - Setup em Azure App Services + +> [!NOTE] +> A documentação deste sistema encontra-se em construção. Pedimos desculpas pela inconveniência. Por favor contate-nos caso +> precise de alguma informação que ainda não está documentada. + +## Veja também + +* [Instalação do Rest PKI Core em Azure App Services](install.md) +* [Atualização do Rest PKI Core em Azure App Services](update.md) +* [Resolução de problemas](troubleshoot/index.md) diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/install.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/install.md new file mode 100644 index 00000000..dcd45897 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/install.md @@ -0,0 +1,154 @@ +# Instalação do Rest PKI Core em Azure App Services + +Para instalar uma instância [*on premises*](../index.md) do [Rest PKI Core](../../index.md) em um [Azure App Service](https://docs.microsoft.com/azure/app-service/overview), +siga os passos abaixo. Para outras plataformas, [clique aqui](../index.md). + +[!include[Veja o planejamento](./includes/see-planning.md)] + +> [!TIP] +> Para permitir o uso do recurso de certificados SSL gratuitos pelo *App Service Managed Certificates*, +> sugerimos não escolher "naked domains", ou seja, domínios sem porção de subdomínio, por exemplo ~~patorum.com~~. +> Prefira, por exemplo, `ac.patorum.com`. + +## Preparação + +As instruções a seguir assumem que você já tem instalado localmente o [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) e já possui +os seguintes recursos criados na sua conta do Azure: + +* Um *SQL Server* (a criação do *SQL database* é coberta por este artigo) +* Um *App Service Plan* com sistema operacional **Linux** (a criação do App Service é coberta por este artigo) +* Zonas de DNS referentes ao [domínio de acesso ao painel de controle](../index.md#dashboard-domain) + e aos [domínios de acesso](../index.md#access-domains) + +Durante a instalação, serão criados alguns recursos: + +* Um *Container Registry* +* Um banco de dados (*SQL database*) +* Uma *storage account* +* Um App Service +* Um Azure Key Vault (opcional) + +[!include[Recomendações](./includes/prep-recommendations.md)] + +[!include[Criação do Container registry](./includes/create-acr.md)] + +Uma vez concluida a criação do *container registry*, replique a imagem de Docker do sistema para ele (substitua `MY_ACR_NAME` pelo nome escolhido +no passo anterior): + +```sh +az login +az acr import --name MY_ACR_NAME --source docker.io/lacunasoftware/restpkicore:2.0.1 --image restpkicore:2.0.1 +``` + +[!include[Criação do banco de dados](./includes/create-database.md)] + +[!include[Criação de uma storage account](./includes/create-storage.md)] + +[!include[Criação do App Service](./includes/create-webapp-docker.md)] + +## Configuração de domínios + +Crie os apontamentos necessários para o [domínio de acesso ao painel de controle](../index.md#dashboard-domain) e +os [domínios de acesso](../index.md#access-domains): + +> [!NOTE] +> Dependendo das suas escolhas, o procedimento abaixo pode ter que ser feito apenas 1 vez (se você escolheu apenas um +> domínio de acesso e pretende usá-lo também como domínio de acesso ao painel de controle) ou até 3 vezes (se você escolheu +> dois domínios de acesso e pretende usar um terceiro domínio para acessar o painel de controle). + +[!include[Crie o registro de DNS](./includes/create-dns-record.md)] + +Após criar os apontamentos para todos os domínios (de 1 a 3 domínios dependendo das suas escolhas), +adicione os domínios ao *App Service* (repita o procedimento abaixo para cada domínio): + +[!include[Adicione o domínio](./includes/add-custom-domain.md)] + +## Configuração do Rest PKI Core + +No menu lateral do App Service, na seção *Development Tools*, clique em **SSH**, em seguida em **Go →**. Você será levado a um terminal. Navegue +para a pasta `/app`: + +```bash +cd /app +``` + +> [!TIP] +> Embora o terminal pareça iniciar na pasta `/app`, o comando acima **é necessário** devido a um bug do Azure + +Execute o comando abaixo para gerar a chave criptográfica utilizada para cifrar valores sensíveis no banco de dados: + +```cmd +dotnet Lacuna.RestPki.Site.dll -- gen-enc-key +``` + +Tome nota do valor gerado. + +Escolha uma senha forte para proteger o acesso de *root* ao painel de controle, e calcule o hash dessa senha com o comando abaixo: + +```cmd +dotnet Lacuna.RestPki.Site.dll -- hash-root-pass +``` + +Novamente, tome nota do valor gerado. + +Feche o terminal, voltando ao portal do Azure. No App Service, vá em **Configuration** e adicione as seguintes configurações: + +* `General__EncryptionKey`: chave criptográfica gerada acima +* `General__RootPasswordHash`: hash da senha de *root* calculado acima +* `General__SiteUrl`: URL pública do site, localizada no [domínio de acesso ao painel de controle](../index.md#dashboard-domain) (ex: `https://ca.patorum.com/`) +* `General__SiteName`: nome da sua instância do Rest PKI Core, ex: *Patorum CA* +* `Oidc__Enabled`: `False` (desabilita a [integração com OpenID Connect](../configure-oidc.md), por ora) +* `Email__Enabled`: `False` (Configura o [envio de e-mail](../configure-email.md), por ora) + +Adicione, também, as configurações descritas nas seções a seguir. + +### PKI Suite + +Configurações do PKI Suite: + +* `PkiSuite__SdkLicense`: sua licença para PKI SDK, no formato Base64 (**obrigatório**) +* `PkiSuite__WebLicense`: sua licença para o componente Web PKI no formato binário (Base64). Somente obrigatório se usuário vai emitir certificados em seus computadores (procedimento de emissão web) + +### Blob Storage + +Configuração da *storage account*: + +* `BlobStorage__ConnectionString`: *connection string* da *storage account* criada anteriormente + +### Logging + +Configuração de log: + +* `Serilog__WriteTo__0__Args__connectionString`: *connection string* da *storage account* criada anteriormente + +### Bindings + +* `Bindings__UseReverseProxy`: Defina como `False` se Rest PKI Core não estiver atrás de um proxy reverso (no Docker quase sempre está) +* `Bindings__HttpsMode`: Se HTTPS estiver configurado, você poderá alterar a configuração abaixo para `RedirectPages` ou `Strict` + +### Connection string + +Na seção *Connection strings* (final da página de configurações), clique em **+ New connection string** e preencha: + +* **Name**: `DefaultConnection` +* **Value**: valor da connection string obtido durante a criação do banco de dados +* **Type**: escolha **SQLAzure** (Esta configuração é refente ao banco de dados criado acima, se estiver utilizando o Postgres escolha **PostgreSQL**) + +Salve as configurações feitas até o momento clicando em **Save**. + +[!include[Optional settings](./includes/optional-settings.md)] + +> [!NOTE] +> Nos links acima, sempre que for mencionado algo como "na seção **Sec**, atribua a configuração **Conf** ao valor ...", no Azure App Services você deve +> compor o nome da configuração com os nomes da seção e da configuração separados por `__` (**dois** *underscores*), ou seja, no exemplo acima: `Sec__Conf` + +## Iniciando o App Service + +Por fim, remova a configuração `STANDBY` do App Service e salve as configurações. Em seguida, acesse a URL do painel de controle (o primeiro acesso pode demorar alguns instantes). + +Autentique-se com a senha de *root* escolhida durante a configuração. Você então terá acesso ao painel de controle, e a instalação estará concluída. + +## Veja também + +* [Atualização do Rest PKI Core em Azure App Services](update.md) +* [Resolução de problemas](troubleshoot/index.md) diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/check-logs.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/check-logs.md new file mode 100644 index 00000000..49ad5cc2 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/check-logs.md @@ -0,0 +1,11 @@ +# Verificando os logs de sistema (Azure App Services) + +Por padrão, os logs de sistema ficam localizados na tabela `AppLogs` da conta de **Azure Storage** criada para o sistema no momento +da instalação. + +Para conferir qual conta e tabela estão sendo utilizadas, vá em **App Services** > (selecione o app service) > **Configuration** e verifique o valor +das configurações `Serilog:WriteTo:0:Args:connectionString` e `Serilog:WriteTo:0:Args:storageTableName`. + +> [!NOTE] +> Alguns erros, geralmente os que ocorrem durante a inicialização do sistema, podem não ser registrados no arquivo de log do sistema. +> Para diagnosticar tais erros, veja [Diagnosticando problemas na inicialização](startup-errors.md). diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/index.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/index.md new file mode 100644 index 00000000..78903f40 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/index.md @@ -0,0 +1,14 @@ +# Resolução de problemas do Rest PKI Core (Azure App Services) + +Problemas comuns: + +* *HTTP Error 500.30 - ANCM In-Process Start Failure* ao tentar acessar o site - veja [Diagnosticando problemas na inicialização](startup-errors.md) +* *HTTP Error 502.5 - ANCM Out-Of-Process Startup Failure* ao tentar acessar o site - veja [Diagnosticando problemas na inicialização](startup-errors.md) + +> [!NOTE] +> Se você está encontrando um problema não listado, tente [verificar os logs de sistema](check-logs.md) ou entre em contato conosco. + +## Veja também + +* [Verificando os logs de sistema](check-logs.md) +* [Diagnosticando problemas na inicialização](startup-errors.md) diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/startup-errors.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/startup-errors.md new file mode 100644 index 00000000..2c00b58e --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/troubleshoot/startup-errors.md @@ -0,0 +1,42 @@ +# Diagnosticando problemas na inicialização (Azure App Services) + +Ao iniciar sua [instância *on premises*](../../index.md) do [Rest Pki Core](../../../index.md) hospedada no [Azure App Services](../index.md), é possível que ocorra +um dos seguintes erros: + +* *HTTP Error 500.30 - ANCM In-Process Start Failure* +* *HTTP Error 502.5 - ANCM Out-Of-Process Startup Failure* + +Em ambos casos, siga os passos abaixo para habilitar os logs de inicialização do sistema. + +## Habilitando logs de inicializaçãoa + +Acesse os arquivos do App Service por FTP, navegue até a pasta */site/wwwroot* e copie o arquivo *web.config* para o seu computador. + +Em seguida, edite o arquivo alterando o elemento `aspNetCore`, setando o valor do atributo `stdoutLogEnabled` para `true`. + +Por exemplo, suponha que o elemento `aspNetCore` está inicialmente conforme abaixo: + +```xml + +``` + +Após alterar o atributo `stdoutLogEnabled` para `true`, o elemento ficaria da seguinte maneira: + +```xml + +``` + +Além disso, confirme que o atributo `stdoutLogFile` está com o valor `.\logs\stdout`, conforme acima. + +Copie o arquivo *web.config* de volta para a pasta */site/wwwroot* do App Service via FTP, substituindo o arquivo antigo. + +Aguarde alguns segundos e tente acessar o site novamente, em seguida recarregue os arquivos do App Service no seu acesso por FTP. Deve aparecer uma nova pasta chamada +*logs*. Entre na nova pasta e inspecione os arquivos. Eles devem revelar a causa raiz do problema. + +> [!WARNING] +> Lembre-se de alterar o atributo `stdoutLogEnabled` de volta para `false` após concluir o diagnóstico complete, já que um grande volume de logs podem ser gerados, +> potencialmente afetando o desempenho do sistema. + +## See also + +* [Resolução de problemas do Rest PKI Core](index.md) diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/azure/update.md b/docs.pt-br/articles/rest-pki/core/on-premises/azure/update.md new file mode 100644 index 00000000..f09c7530 --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/azure/update.md @@ -0,0 +1,14 @@ +# Atualização do Rest PKI Core em Azure App Services + +Replique a última imagem de Docker do sistema para seu *container registry* (substitua `MY_ACR_NAME` pelo nome escolhido no passo anterior): + +```sh +az acr import --name MY_ACR_NAME --source docker.io/lacunasoftware/restpkicore:4.6.1 --image restpkicore:4.6.1 +``` + +Em seguida, no App Service do sistema, vá em **Deployment Center** e, no campo **Tag**, selecione a nova versão e clique em **Save**. + +## Veja também + +* [Instalação do Rest PKI Core em Azure App Services](install.md) +* [Resolução de problemas](troubleshoot/index.md) diff --git a/docs.pt-br/articles/rest-pki/core/on-premises/configure-https-redirect.md b/docs.pt-br/articles/rest-pki/core/on-premises/configure-https-redirect.md new file mode 100644 index 00000000..a9d7fa4d --- /dev/null +++ b/docs.pt-br/articles/rest-pki/core/on-premises/configure-https-redirect.md @@ -0,0 +1,4 @@ +# Configurando de redirecionamento para HTTPS - Rest PKI Core + + +