Integrar uma organização

Para integrar uma organização, crie um arquivo de configuração de integração e transmita-o ao comando setup-org. Cada uma dessas etapas é descrita nas seções a seguir.

Para informações sobre como usar a API Management para integrar uma organização, consulte Criar uma organização, um ambiente e um host virtual.

Criar um arquivo de configuração de integração

Esta seção inclui um arquivo de configuração de amostra para integrar uma organização com setup-org.

Copie o exemplo a seguir e edite conforme necessário para sua organização:

# Specify the IP or DNS name of the Management Server.
IP1=MANAGEMENT_SERVER_IP_ADDRESS

MSIP="$IP1"

# Specify the Edge sys admin credentials.
ADMIN_EMAIL="admin@email.com"
APIGEE_ADMINPW=admin_password  # If omitted, you are prompted for it.

# Specify organization name.
ORG_NAME=myorg  # lowercase only, no spaces, underscores, or periods.

# Specify the organization administrator user.
# Either specify an existing user, or specify the information
# necessary to create a new user.
# Do not use the sys admin as the organization administrator.
#
# Create a new user for the organization administrator.
NEW_USER="y"
# New user information if NEW_USER="y".
USER_NAME=new@user.com
FIRST_NAME=new
LAST_NAME=user
# Org admin password must be at least 8 characters long and contain one uppercase
# letter, one lowercase letter, and one digit or special character
USER_PWD="newUserPword"
ORG_ADMIN=new@user.com
#
# Or, specify an existing user as the organization admin,
# omit USER_NAME, FIRST_NAME, LAST_NAME, USER_PWD.
# NEW_USER="n"
# ORG_ADMIN=existing@user.com

# Specify environment name.
ENV_NAME=prod  # lowercase only

# Specify virtual host information.
VHOST_PORT=9001
VHOST_NAME=default

# If you have a DNS entry for the virtual host.
VHOST_ALIAS=myorg-test.apigee.net

# If you do not have a DNS entry for the virtual host,
# specify the IP and port of each router as a space-separated list:
# VHOST_ALIAS="firstRouterIP:9001 secondRouterIP:9001"

# Optionally configure TLS/SSL for virtual host.
# VHOST_SSL=y     # Set to "y" to enable TLS/SSL on the virtual host.
# KEYSTORE_JAR=   # JAR file containing the cert and private key.
# KEYSTORE_NAME=  # Name of the keystore.
# KEYSTORE_ALIAS= # The key alias.
# KEY_PASSWORD=   # The key password, if it has one.

# Specify the analytics group.
# AXGROUP=axgroup-001 # Default name is axgroup-001.

Observações:

  • Para VHOST_ALIAS, se você já tiver um registro DNS que será usado para acessar o host virtual, especifique o alias do host e, opcionalmente, a porta, por exemplo, "myapi.example.com". Se você ainda não tiver um registro DNS use o endereço IP do roteador.

    Para mais informações sobre como configurar o host virtual, consulte Configurar um host virtual.

  • Para a configuração de TLS/SSL, consulte Keystores e Truststores e Configuring TLS access to an API for the nuvem privada para mais informações sobre como criar o arquivo JAR, e outros aspectos da configuração de TLS/SSL.
  • Para mais informações sobre como configurar hosts virtuais, consulte Configurar o acesso TLS a uma API para a nuvem privada.
  • Não é possível criar duas organizações com o mesmo nome. Nesse caso, a segunda criação vai falhar.

Executar setup-org

Depois de criar o arquivo de configuração de integração, transmita-o ao setup-org script para realizar o processo de integração. É necessário executar o script no nó do servidor de gerenciamento.

Ao integrar uma organização, o script setup-org faz o seguinte:

  • Cria uma nova organização.
  • Cria um ambiente.
  • Cria um host virtual para o ambiente.
  • Define o usuário especificado como administrador da organização. Observações:
    • É possível usar um usuário atual ou criar um novo para o administrador da organização.
    • O administrador da organização não pode ser o mesmo que o administrador do sistema.
  • Associa a organização ao pod "gateway". Essa é a opção padrão e não pode ser alterada.
  • Associa o ambiente a todos os processadores de mensagens.
  • Ativa a análise.

Para executar setup-org:

  1. Instale apigee-provision no nó do servidor de gerenciamento:
    /opt/apigee/apigee-service/bin/apigee-service apigee-provision install
  2. Execute o script setup-org no nó do servidor de gerenciamento e aponte-o para o arquivo de configuração criado em Criar um arquivo de configuração de integração:
    /opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile

    O arquivo de configuração precisa ser legível pelo usuário "apigee".

  3. Verifique se você integrou uma organização. Uma maneira de fazer isso é fazer log na nova interface do Edge solicitando o seguinte URL em um navegador:
    http://IP_address:3001

    Em que IP_address é o endereço IP do servidor em que você instalou a nova interface do Edge.

    Para outras etapas de verificação, consulte Verificar a integração.

  4. Crie seu primeiro proxy.

Verificar a integração

Após a conclusão da integração, verifique o status do sistema emitindo os seguintes curl comandos no nó do servidor de gerenciamento:

  1. Verifique o status do usuário e da organização no servidor de gerenciamento executando os seguintes comandos:
    curl -u adminEmail:admin_passwd http://localhost:8080/v1/users
    curl -u adminEmail:admin_passwd http://localhost:8080/v1/organizations
    curl -u adminEmail:admin_passwd http://localhost:8080/v1/organizations/org_name/deployments
  2. Verifique a análise executando o seguinte comando:
    curl -u adminEmail:admin_password http://localhost:8080/v1/organizations/org_name/environments/env_name/provisioning/axstatus
  3. Verifique o status do banco de dados PostgreSQL executando os seguintes comandos no nó 2 (conforme mostrado nas topologias de instalação):
    psql -h /opt/apigee/var/run/apigee-postgresql -U apigee apigee

    No prompt de comando, digite o seguinte comando para conferir a tabela de análise da sua organização:

    \d analytics."org_name.env_name.fact"

    Use o comando a seguir para sair do psql:

    \q
  4. Acesse a nova interface do Edge usando um navegador da Web. Lembre-se de que você já anotou o URL do console de gerenciamento no final da instalação.
    1. Inicie o navegador de sua preferência e insira o URL da nova interface do Edge. Ele é semelhante ao seguinte, em que o endereço IP é para o nó 1 (conforme mostrado nas topologias de instalação) ou qualquer nó em que você instalou a nova interface do Edge para configurações alternativas:
      http://192.168.56.111:3001

      3001 é o número da porta padrão usado pela nova interface do Edge.

      Se você estiver iniciando o navegador diretamente no servidor que hospeda a nova interface do Edge, então você pode usar um URL no formato:

      http://localhost:3001
    2. Na página de login do console, especifique o nome de usuário/senha do administrador do sistema da Apigee.
  5. Inscreva-se em uma nova conta de usuário da Apigee e use a nova credencial de usuário para fazer login. Na página de login do console, clique no botão Fazer login.

    O navegador redireciona para http://192.168.56.111:3001/edge e abre um painel que permite configurar a organização criada (se você fez login usando as credenciais de administrador da Apigee).

Criar seu primeiro proxy

Depois de integrar uma nova organização e verificar se o processo de integração foi bem-sucedido, você pode criar seu primeiro proxy. Para mais informações, consulte Criar seu primeiro proxy de API.

Outros recursos que podem ser úteis incluem: