Manual do Usuário ATER

Índice

1. Acessando o Sistema
2. Tela de Login
3. Tela inicial
4. Alteração de Dados do Usuário
5. Criação de Regras
6. Visualização de Regras

1 Acessando o Sistema

O usuário poderá ter acesso ao sistema, e aos serviços ATER pelo endereço https://ater.cipo.rnp.br.

2 Tela de Login

Para ter acesso ao serviço é necessário possuir uma conta cadastrada no sistema ATER.

O Login deve ser efetuado informando-se o nome de usuário e senha de acesso ao sistema, clicando, em seguida, no botão Entrar.

O usuário que ainda não possui cadastro no sistema ATER deverá acessar a página inicial do sistema e clicar em Solicitar Cadastro. O usuário deverá então preencher o formulário de solicitação de cadastro informando: login do usuário, senha, nome completo e e-mail para contato. Em seguida, deve-se selecionar o POP ao qual o usuário está associado, bem como sua instituição. Para confirmar a operação é necessário clicar no botão Solicitar Cadastro.

Após concluir o cadastro, o usuário receberá em sua tela uma mensagem de confirmação referente a sua solicitação.

3 Tela Inicial

Ao efetuar login no sistema, a tela abaixo será apresentada ao usuário, contendo as seguinte opções:

• Minha Conta: Apresenta as informações relativas ao usuário logado no sistema ATER. Permite ainda a alteração de dados do usuário.
  
• Dashboard: Exibe a página inicial do sistema.
• Regras: Menu com opções de regras relativas ao usuário ATER.
• Nova Regra: Permite criar uma nova regra no sistema ATER.
• Minhas Regras: Lista todas as regras do usuário no sistema ATER.

4 Alteração de Dados do Usuário

O usuário ATER poderá realizar alteração de dados pessoais acessando sua conta na interface web e clicando em Minha Conta, no menu superior direito.

5 Criação de Regras

Ao logar no sistema, o usuário será direcionado para a página principal (Dashboard) do serviço ATER. Nessa página, ele tem a opção de solicitar a criação de novas regras ou visualizar regras já criadas ou solicitadas.

Para solicitar a criação de uma nova regra, é preciso clicar no botão Nova Regra. Alternativamente, é possível clicar em Solicitar Regra, no menu à esquerda, sob a guia Regras, conforme mostrado na figura abaixo.

Na página de solicitação de criação de regra, o usuário deve preencher os seguintes campos para:

6 Visualização de Regras

Para visualizar suas regras o usuário deve acessar a página principal do serviço ATER (Dashboard) e clicar no botão Minhas Regras. Alternativamente, é possível clicar em Todas as Regras ou mesmo em Regras Pendentes no menu à esquerda, sob a guia Regras.

Ao visualizar suas regras o usuário pode ainda executar duas ações:

• Visualizar todos os dados da regra detalhadamente. Para isto, o usuário deve clicar no ícone da lupa.
• Remover a regra. Para isto, o usuário deve clicar no ícone da lixeira. 

O usuário pode também filtrar as regras que ele deseja por meio do menu de filtros. Os filtros são divididos em:

• Status da regra que se deseja filtrar.
• Tipo da Regra que se deseja filtrar.
• Protocolo de Rede que se deseja filtrar.
• Protocolo de Transporte que se deseja filtrar.
• IP de Origem que se deseja filtrar.
• IP de Destino que se deseja filtrar.

A tela abaixo é exibida quando se deseja visualizar os detalhes de uma regra específica. 
Na tela de visualização da regra é possível verificar dados mais específicos da regra em questão, além de verificar os circuitos que aquela está ou esteve associada.

Manual do Gerente Local ATER

Índice

1. Acessando o Sistema
2. Tela de Login
3. Tela inicial
4. Gerencia de usuários
   1. Consulta a usuários
   2. Criação de Usuários
   3. Aprovação de solicitação de Cadastro de usuário
5. Gerência de Regras
   1. Criação de Regras
   2. Visualização de Regras
   3. Aprovação de Solicitação de Criação de Regras
6. Monitoramento
   1. Regras
   2. Circuitos

1 Acessando o Sistema

O Gerente Local poderá ter acesso ao sistema, e aos serviços ATER pelo endereço https://ater.cipo.rnp.br.

2 Tela de Login

Para ter acesso ao serviço é necessário possuir uma conta cadastrada no sistema ATER.

O Login deve ser efetuado informando-se o nome de usuário e senha de acesso ao sistema, clicando, em seguida, no botão Entrar.

O Gerente Local que ainda não possua senha de acesso ao sistema, deverá realizar o cadastro como usuário comum, solicitando posteriormente, ao administrador do sistema a alteração de seu perfil. Para tal, o Gerente Local deverá acessar a página inicial do sistema e clicar em Solicitar Cadastro, preenchendo o formulário de solicitação de cadastro informando: login do usuário, senha, nome completo e e-mail para contato. Em seguida, deve-se selecionar o POP ao qual o usuário está associado, bem como sua instituição. Para confirmar a operação é necessário clicar no botão Solicitar Cadastro.

Após concluir o cadastro, o Gerente Local receberá em sua tela uma mensagem de confirmação referente a sua solicitação.

3 Tela Inicial

Ao efetuar login no sistema, a tela abaixo será apresentada ao usuário, contendo as seguinte opções:

• Minha Conta: Apresenta as informações relativas ao Gerente Local logado no sistema ATER. Permite ainda a alteração de dados do Gerente Local.
  
• Dashboard: Exibe a página inicial do sistema.
• Regras: Permite ao Gerente Local a criação de novas regras.
• Pendências: Exibe ao Gerente Local os usuários e regras que ainda dependam de sua aprovação para funcionamento.
• Gerência: Permite ao Gerente Local a alteração/exclusão de usuários e/ou regras, e a visualização de relatórios.
• Monitoramento: Permite ao Gerente Local o monitoramento de circuitos e regras ativos no momento.
• Usuários: Permite que o Gerente Local visualize os usuários referentes ao seu POP, edite ou exclua-os.
• Regras Pendentes: Exibe as solicitações de regras efetuadas pelos usuários e que ainda demandem de aprovação do Gerente Local do POP.
• Nova Regra: Permite criar uma nova regra no sistema ATER.
• Minhas Regras: Lista todas as regras do usuário no sistema ATER.

4 Gerência de Usuários

Na página inicial do sistema (Dashboard), clique em Usuários. Alternativamente, é possível clicar em Usuários, no menu à esquerda, sob a guia Gerência.

4.1 Consulta a Usuários

Ao visualizar os usuários do sistema, é possível executar as seguintes ações:

• Visualizar os dados de um usuário particular. Para isto, selecione um usuário e clique na "Lupa".
• Remover um usuário. Para isto selecione o usuário e clique na "Lixeira".
• Cadastrar um novo usuário. Para isto clique em "+ Adicionar".

4.2 Criação de Usuários

Para cadastrar um novo usuário, deve-se preencher o formulário abaixo, informando o login do usuário, senha, nome completo e e-mail. Também é necessário informar o grupo, e o local onde o usuário pertence ( POP e instituição ou dependendo das permissões do gerente local, apenas a instituição ). Atualmente, existem dois grupos de usuários ao qual um gerente local pode associar usuários:

• Cliente: pode solicitar a criação de regras e monitorar as estatísticas relacionadas às suas regras.

• Gerente Local: pode realizar as mesmas operações que o usuário comum além de poder aprovar as próprias regras.

O Administrador pode habilitar ou desabilitar o acesso do usuário à API ATER.

4.3 Aprovação de Solicitação de Cadastro de Usuário

Contas criadas por usuários pertencentes ao grupo cliente devem ser aprovadas por um gerente local ou um administrador. Para aprovar uma solicitação de criação de usuário, clique em Usuários, no menu esquerdo, sob a guia Pendências.

Ao visualizar as solicitações de criação de conta, é possível executar as seguintes ações:

• Aprovar a solicitação, clicando no ícone de "Aprovação".
• Recusar a solicitação, clicando no ícone de "Remoção".
• Visualizar os dados do solicitante, clicando na "Lupa".

5 Gerência de Regras

5.1 Criação de Regras

Na página inicial do sistema (Dashboard), clique em Nova Regra. Alternativamente, é possível clicar em Nova Regra, no menu à esquerda, sob a guia Regras.

Na página de solicitação de criação de regra, o usuário deve preencher os seguintes campos para:

• Criar uma nova regra simples:

• Criar um nova regra habilitando a edição de parâmetros avançados:

A criação de uma regra com parâmetros avançados solicita:

• Protocolo de Rede: Define o padrão de comunicação entre origem e destino. São dois: IPv4 e IPv6 ( Não habilitado ). 
• Ao preencher os campos IP de Origem e IP de Destino é possível informar também a máscara de sub-rede. Para isso, é necessário marcar a opção Rede, logo acima do campo Ip de Origem ou Ip de Destino. Caso contrário, pode-se deixar a máscara de sub-rede com o valor 32 ou simplesmente marcar a opção padrão Host.
• Configurar Protocolo de Transporte e Portas de Origem/Destino: Caso esta opção seja marcada, alguns campos de formulário adicionais surgirão. Através deles, será possível definir o Protocolo de Transporte(TCP, UDP, ICMP, DCCP, SCTP)assim como as portas de origem e destino. 
  • Observação: Você pode utilizar range de portas separando-as por (:) dois pontos. Exemplo: 2000:2010 equivale as portas 2000,2001,2002,...,2010
• Largura de Banda do Canal: Define a quantidade de tráfego de dados no circuito em megabits por segundo.
• Tipo da Regra: Existem dois tipos de regra:
• Monitoramento: essa regra não gera circuito dinâmico, mas todo tráfego que casa com a regra é contabilizado.
• Efetiva: essa regra gera um circuito dinâmico quando o tráfego casar com a regra.

5.2 Visualização de Regras

Na página inicial do sistema (Dashboard), clique em Minhas Regras. Alternativamente, é possível clicar em Todas as Regras ou mesmo em Regras Pendentes (para visualizar somente as regras ainda à espera de aprovação), no menu à esquerda, sob a guia Regras. O Gerente Local visualiza apenas as regras associadas aos RACEs ao qual o POP ao qual está associado.
Alternativamente, é possível utilizar apenas uma das páginas e visualizar as regras utilizando apenas os filtros.

Ao visualizar as regras existentes no sistema, é possível executar as seguintes ações:

• Visualizar os dados de uma regra particular. Para isto, selecione a regra e clique na "Lupa".
• Remover uma regra particular. Para isto, selecione a regra e clique na "Lixeira".

Abaixo temos a página de visualização de uma regra.

5.3 Aprovação de Solicitação de Criação de Regras

Na página inicial do sistema, clique em Regras, sob a guia Pendências.

O gerente local pode aprovar apenas as regras solicitadas por clientes do mesmo POP e / ou instituição ao qual ele pertence.

Ao visualizar as solicitações de criação de regras, é possível executar as seguintes ações:

• Remover a solicitação. Para isto, selecione a regra e clique na "Lixeira".
• Visualizar os dados da regra e aprová-la. Para isto, selecione a regra e clique na "Lupa".

Abaixo temos a página de visualização de uma regra pendente.

Para aprovar a regra você precisa clicar no botão "Aprovar regra", em seguida deverá especificar a duração do circuito daquela regra e clicar novamente em "Aprovar regra".

Caso não queira aprovar a regra, basta que o Gerente Local clique em Remover.

6 Monitoramento

6.1 Regras

Para monitorar as regras cadastradas, clique no item Regras sob a guia Monitoramento.

Para visualizar os gráficos de vazão de bytes e de pacotes clique sobre o ícone da "Lupa".

6.2 Circuitos

Para monitorar os circuitos existentes, clique no item Circuitos sob a guia Monitoramento.

Para visualizar os gráficos de vazão de bytes e de pacotes clique sobre o ícone da "Lupa".

Manual do Administrador ATER

Índice

1. Acessando o Sistema
2. Tela de Login
3. Gerencia de Usuários
   1. Consulta a usuários
   2. Criação de Usuários
   3. Aprovação de Solicitação de Cadastro de Usuários
4. Gerência de Redes
   1. Criação de Regas
   2. Visualização de Regras
   3. Aprovação de Solicitação de Criação de Regras
5. Configuração de Serviço
   1. Operações Básicas
   2. Configurações de Parâmetros
6. Monitoramento
   1. RACEs (Rule Applier and Circuit Endpoint)
   2. Regras
   3. Circuitos

1 Acessando o Sistema

O Administrador poderá ter acesso ao sistema, e aos serviços ATER pelo endereço https://ater.cipo.rnp.br.

2 Tela de Login

Para ter acesso ao serviço é necessário possuir uma conta cadastrada no sistema ATER.

O Login deve ser efetuado informando-se o nome de usuário e senha de acesso ao sistema, clicando, em seguida, no botão Entrar.

 

Para o caso de Administradores que não se recordem da senha cadastrada anteriormente, a recuperação da mesma poderá ser feita através do botão Esqueceu a senha. Ao clicar nele, o usuário será redirecionado a tela abaixo, onde deverá fornecer o e-mail cadastrado no sistema, e seguir os passos indicados.

3 Gerência de Usuários

Na página inicial do sistema (Dashboard), clique em Usuários. Alternativamente, é possível clicar em Usuários, no menu à esquerda, sob a guia Gerência.

3.1 Consulta a Usuários

Ao visualizar os usuários do sistema, é possível executar as seguintes ações:

• Visualizar os dados de um usuário particular. Para isto, selecione um usuário e clique na "Lupa".
• Remover um usuário particular. Para isto selecione o usuário e clique em "Lixeira".
• Cadastrar um novo usuário. Para isto clique no botão "+ Adicionar".

3.2 Criação de Usuários

Para cadastrar um novo usuário, deve-se preencher o formulário abaixo, informando o login do usuário, senha, nome completo e e-mail. Também é necessário informar o grupo e o POP juntamente com a instituição ( opcional ) a que pertence o usuário. Atualmente, existem três grupos de usuários:

•  Cliente: pode solicitar a criação de regras e monitorar as estatísticas relacionadas às suas regras.

•  Gerente Local: pode realizar as mesmas operações que o usuário comum além de poder aprovar as próprias regras.

•  Administrador: pode realizar qualquer operação. Entre elas, aprovar solicitações de criação de contas de usuários, regras, criar regras, configurar o serviço, remover e criar usuários.

 O administrador pode também habilitar ou desabilitar o acesso do usuário à API ATER.

Aprovação de Solicitação de Cadastro de Usuário

Contas criadas por usuários pertencentes ao grupo cliente devem ser aprovadas por um gerente local ou um administrador. Para aprovar uma solicitação de criação de usuário, clique em Usuários, no menu esquerdo, sob a guia Pendências.

Ao visualizar as solicitações de criação de conta, é possível executar as seguintes ações:

• Aprovar a solicitação, clicando no ícone de "Aprovação".
• Recusar a solicitação, clicando no ícone de "Reprovação".
• Visualizar os dados do solicitante, clicando na "Lupa".

4 Gerência de Regras

4.1 Criação de Regras

Na página inicial do sistema (Dashboard), clique em Nova Regra. Alternativamente, é possível clicar em Nova Regra, no menu à esquerda, sob a guia Regras.

 

Na página de solicitação de criação de regra, o usuário deve preencher os seguintes campos para:

• Criar uma nova regra simples:

• Criar um nova regra habilitando a edição de parâmetros avançados:

A criação de uma regra com parâmetros avançados solicita:

• Protocolo de Rede: Define o padrão de comunicação entre origem e destino. São dois: IPv4 e IPv6 ( Não habilitado ). 
• Ao preencher os campos IP de Origem e IP de Destino é possível informar também a máscara de sub-rede. Para isso, é necessário marcar a opção Rede, logo acima do campo Ip de Origem ou Ip de Destino. Caso contrário, pode-se deixar a máscara de sub-rede com o valor 32 ou simplesmente marcar a opção padrão Host.
• Configurar Protocolo de Transporte e Portas de Origem/Destino: Caso esta opção seja marcada, alguns campos de formulário adicionais surgirão. Através deles, será possível definir o Protocolo de Transporte(TCP, UDP, ICMP, DCCP, SCTP)assim como as portas de origem e destino. 
  • Observação: Você pode utilizar range de portas separando-as por (:) dois pontos. Exemplo:2000:2010 equivale as portas 2000,2001,2002,...,2010
• Largura de Banda do Canal: Define a quantidade de tráfego de dados no circuito em megabits por segundo.
• Tipo da Regra: Existem dois tipos de regra:
• Monitoramento: essa regra não gera circuito dinâmico, mas todo tráfego que casa com a regra é contabilizado.
• Efetiva: essa regra gera um circuito dinâmico quando o tráfego casar com a regra.

4.2 Visualização de Regras

Na página inicial do sistema (Dashboard), clique em Minhas Regras. Alternativamente, é possível clicar em Todas as Regras ou mesmo em Regras Pendentes (para visualizar somente as regras ainda à espera de aprovação do administrador), no menu à esquerda, sob a guia Regras.
Alternativamente, é possível utilizar apenas uma das páginas e visualizar todas as regras utilizando apenas os filtros.

Ao visualizar as regras existentes no sistema, é possível executar as seguintes ações:

• Visualizar os dados de uma regra particular. Para isto, selecione a regra e clique na "Lupa".
• Remover uma regra particular. Para isto, selecione a regra e clique na "Lixeira".

 Abaixo temos a página de visualização de uma regra.

4.3 Aprovação de Solicitação de Criação de Regras

Na página inicial do sistema, clique em Regras, sob a guia Pendências ou acesse qualquer outra página de regras, limpe os filtros e selecione o status de regra pendente.

Ao visualizar as solicitações de criação de regras, é possível executar as seguintes ações:

• Remover a solicitação. Para isto, selecione a regra e clique no ícone "Lixeira".
• Visualizar os dados da regra e aprová-la. Para isto, selecione a regra e clique no ícone "Lupa".

Abaixo temos a página de visualização de uma regra pendente.

Para aprovar a regra você precisa clicar no botão "Aprovar regra", em seguida deverá especificar a duração do circuito daquela regra e clicar novamente em "Aprovar regra".

5 Configuração do Serviço

É na configuração do serviço que são definidos os pré-requisitos básicos para o funcionamento do serviço ATER.
Para realizar qualquer tipo de configuração, clique sob a guia Configurações no menu à esquerda. O serviço ATER pode ser configurado com base nas informações seguintes.

5.1 Operações Básicas

De maneira genérica, para realizar operações de visualização, cadastro e remoção das configurações, clique sobre o menu esquerdo na guia Configurações e selecione qual item deseja configurar.
Clique no ícone da "Lupa" para Visualizar detalhes da configuração cadastrada.
Clique no ícone do "Lápis" para Editar dados da configuração.
Clique no ícone da "Lixeira" para Remover a configuração cadastrada.
Clique sobre o botão Adicionar acima da lista de itens cadastrados para cadastrar um novo item.

 5.1.1 Domínios: Domínios indicam localizações (geralmente POPs) onde o serviço está implantado.

 Para cadastrar um domínio são necessárias as seguintes informações:

• O estado da federação onde o domínio está localizado;
• O nome, telefone e e-mail de contato do responsável pelo serviço neste domínio;
• A url do Oscars.

5.1.2 Equipamentos: Contem informações sobre os equipamentos onde o SE-CIPÓ está implantado. Correspondem aos switches do POD.

 

• A marca e modelo do equipamento;

• O endereço IP que localiza o equipamento;

• O POP ou domínio onde o equipamento está instalado;

• A descrição do equipamento.
  
  

 

• O nome da instituição;

• O nome, telefone e e-mail de contato de um responsável.
  
  

5.1.4 Portas: Contem informações sobre as portas dos equipamentos (POD) nas quais se conectam instituições usuárias do serviço.

 

• O número da porta;

• O equipamento (POD) onde se localiza a porta;

• O endereço IP do RACE que atende a porta;

• A instituição conectada à porta.
  
  

5.5.5 RACEs: Contem informações sobre os RACEs, equipamentos onde são instaladas as regras.

 

• A URN que representa o endpoint do circuito dinâmico onde o RACE se conecta;

• O endereço IP que localiza o RACE;

• A descrição do equipamento.
  
  

5.1.6 Blocos de Endereço:: Contem informações dos blocos de endereço IPv4 associados a cada instituição usuária do serviço.

 

• A instituição a que pertence o bloco de endereço;

• O endereço de rede, como por exemplo 10.1.0.1;

• A máscara de rede.
  
  

5.1.7 Perfis de Tráfego: Contem informações dos perfis de tráfego. O cadastro de perfis de tráfego permite uma maior facilidade no momento de criação da regra, pois, para cada perfil têm-se valores padrão associados ao Protocolo de Transporte e a Porta de Destino.

 

• O nome que identifica o perfil de tráfego;

• O protocolo de transporte usado;

• O número da porta de destino usado.
  
  

5.2 Configuração de Parâmetros

Para acessá-lo, clique sobre o menu esquerdo na guia Configurações e selecione o item Configurações de Serviço. Nesse item é possível visualizar as configurações referentes aos parâmetros do serviço ATER.

Caso deseje editar qualquer um dos parâmetros listados acima, clique no botão Editar Configurações.

6 Monitoramento

6.1 RACEs (Rule Applier and Circuit Endpoint)

Para monitorar o status dos RACEs, clique no item Races sob a guia Monitoramento. 
É possível ainda verificar os status detalhados de monitoramento dos races fornecidos pela ferramenta zabbix clicando no ícone da "Lupa".

6.2 Regras

Para monitorar as regras cadastradas, clique no item Regras sob a guia Monitoramento.

Para visualizar os gráficos de vazão de bytes e de pacotes clique sobre .

6.3 Circuitos

Para monitorar os circuitos existentes, clique no item Circuitos sob a guia Monitoramento.

Para visualizar os gráficos de vazão de bytes e de pacotes clique sobre .