# Instalação e Configuração

### Pré-requisitos

Para integrar com sucesso usando Netacea, certifique-se de que você possui:

1. Acesso às chaves de API relevantes e endpoints de envio de logs da Netacea.

### Etapas de Implementação

1. No console do F5, acesse o item de menu System > Resource Provisioning.

<figure><img src="/files/jHxMoz4tQ0fwovtpFbX6" alt=""><figcaption></figcaption></figure>

2\. Certifique-se de que 'iRules Language Extensions (iRulesLX)' está marcado e possui provisionamento adequado atribuído - 'Nominal' deve ser escolhido.

3\. Em 'Local Traffic > iRules', os itens de menu específicos do LX devem estar presentes.

<figure><img src="/files/XCrZzlGRhNJnpakMGdeg" alt=""><figcaption></figcaption></figure>

#### Fazer upload do workspace <a href="#upload-workspace" id="upload-workspace"></a>

1. Acesse iRules > LX Workspaces
2. Clique no botão 'Import'.

<figure><img src="/files/ls3wkbfOz6s7339yTye7" alt=""><figcaption></figcaption></figure>

3\. Aponte a importação para o workspace fornecido pela Netacea e nomeie o workspace como 'Netacea'.

<figure><img src="/files/4G6uVVkeQwhC6e4rV3kL" alt=""><figcaption></figcaption></figure>

#### Instalando o módulo f5-nodejs <a href="#installing-f5-nodejs-module" id="installing-f5-nodejs-module"></a>

{% hint style="info" %}
**Nota:** Ao conectar via SSH, você pode acabar no `tmos` em vez do bash. Você pode identificar isso na linha de comando se ela contiver a palavra `tmos`, por exemplo:

`username@(ip-172-31-10-207)(cfg-sync Standalone)(Active)(/Common)(tmos)#`

Para acessar o local do arquivo abaixo, você precisará mudar para bash usando o seguinte comando:

`run /util bash`
{% endhint %}

A biblioteca nodejs para iRules LX NÃO está publicada no NPM ([https://www.npmjs.com](https://www.npmjs.com/)) e reside apenas no sistema F5 BIG-IP. Você pode encontrar mais informações no site do F5 [aqui](https://support.f5.com/csp/article/K16221101), bem como no NPM (<https://www.npmjs.com/package/f5-nodejs>).

Devido a esse fato, algumas etapas curtas são necessárias para garantir que o workspace funcione conforme esperado.

* Conecte-se via SSH ao seu nó F5 através de um terminal
* Navegue até o diretório onde seu workspace está localizado, por exemplo: `/var/ilx/workspaces/Common/your_module_name_here/extensions/netacea`
* Uma vez dentro do módulo Netacea, crie um diretório chamado `node_modules`, por exemplo: `mkdir node_modules`
* Navegue até o diretório `node_modules` recém-criado e descompacte os arquivos f5-nodejs executando o comando `tar -xvzf /usr/share/packages/nodejs/f5-nodejs-6.tgz`

Isso instalará o módulo f5-nodejs na pasta `node_module` desejada e pode ser visualizado no console do F5.

#### Adicionando Chaves de API <a href="#adding-api-keys" id="adding-api-keys"></a>

1. Na visualização LX Workspaces - clique no workspace nomeado, por exemplo: 'Netacea'
2. Localize o arquivo config.json e inclua a apiKey e secretKey para o workspace e clique em 'Save File' abaixo
3. Clique no botão 'Reload from Workspace...' que então atualizará os arquivos dentro do workspace.

<figure><img src="/files/9urzBxlj1UMcvThQrbd0" alt=""><figcaption></figcaption></figure>

4\. Certifique-se de que não há 'workspace files' destacados em laranja posteriormente. Isso indica que eles foram alterados desde o último recarregamento do plugin.

As chaves de API são sempre adicionadas e salvas antes de prosseguir para 'Activate Plugin' - caso contrário, falhará ao iniciar.

#### Adicionando seu NetaceaConfig.json <a href="#adding-your-netaceaconfig.json" id="adding-your-netaceaconfig.json"></a>

Existem 5 campos que devem estar localizados no arquivo NetaceaConfig.json. Um exemplo pode ser encontrado abaixo:

{% code overflow="wrap" %}

```
{ 
"apiKey": "API_KEY", 
"secretKey": "SECRET_KEY",
"mitigationType": "MITIGATION_TYPE", // Either "INGEST" or "MITIGATE"
"ingestType": "KINESIS",
"mitigationServiceUrl": "MITIGATE SERVICE URL",
  "kinesis": {
  "kinesisStreamName": "KINESIS_STREAM_NAME",
    "kinesisAccessKey": "KINESIS_ACCESS_KEY",
    "kinesisSecretKey": "KINESIS_SECRET_KEY",
    "logBatchSize": 100,
    "maxLogAgeSeconds": 3
  }
}
```

{% endcode %}

#### Ativar plugin <a href="#activate-plugin" id="activate-plugin"></a>

1. Na visualização LX workspaces - clique na aba 'LX Plugins' e depois no botão 'Create'

<figure><img src="/files/9w0JACfyqm3iOeT3kNQX" alt=""><figcaption></figcaption></figure>

2\. Nomeie o plugin como 'Netacea' e escolha o workspace que acabamos de importar.

<figure><img src="/files/NJwprDypGKhaS1jtGkE9" alt=""><figcaption></figcaption></figure>

#### Habilitando iRules <a href="#enabling-irules" id="enabling-irules"></a>

{% hint style="info" %}
Vale ressaltar que o worker do F5 pode realizar 'INGEST' a partir da iRule mitigate. Habilitar netacea\_mitigate significa que você não precisa ter netacea\_ingest habilitado, pois a iRule mitigate também gerenciará o Ingest. Isso significa que o usuário só precisa atualizar o "mitigationType" localizado no NetaceaConfig.json para alternar entre ingest e mitigate sem alterar a iRule em si.
{% endhint %}

1. Na visualização do servidor virtual relevante, escolha a aba 'Resources' e depois 'manage' para alocação de iRule.

<figure><img src="/files/IEcprjlmqx3Sq2F5Y3AJ" alt=""><figcaption></figcaption></figure>

2\. Encontre as duas iRules da Netacea na lista 'Available', mova a iRule relevante para a caixa 'Enabled' e defina a prioridade desejada. Recomendamos a prioridade mais alta onde não haja conflito.

<figure><img src="/files/Cai9YmbbSxgmyFS83IW8" alt=""><figcaption></figcaption></figure>

**netacea\_ingest** - isso apenas enviará dados de requisição para a Netacea para análise e não tomará nenhuma ação em requisições ao vivo.

**netacea\_mitigate** - isso enviará dados de requisição para a Netacea e mitigará automaticamente as ameaças identificadas de acordo com sua configuração.

### Links úteis <a href="#useful-links" id="useful-links"></a>

F5 Datasheet - <https://www.f5.com/pdf/products/big-ip-local-traffic-manager-ds.pdf>

Visão geral do iRules LX - <https://clouddocs.f5.com/api/irules-lx/>

Documentação da API iRules LX - <https://clouddocs.f5.com/api/irules-lx/APIReference.html>

Guia de Streaming do iRulesLX aqui: <https://readthedocs.org/projects/f5-agility-labs-irules/downloads/pdf/latest/>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.netacea.com/br/informacoes-do-plugin-netacea/f5/installation-and-configuration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.