Edge para nuvem privada v4.18.01
O portal de serviços para desenvolvedores atua como um cliente do Apigee Edge. Isso significa que o portal não funciona como um sistema autônomo. Em vez disso, grande parte das informações usadas pelo portal é armazenada no Edge. Quando necessário, o portal faz uma solicitação para recuperar informações do Edge ou enviar informações para o Edge.
O portal está sempre associado a uma única organização de Edge. Ao configurar o portal, é possível especificar as credenciais básicas de autenticação (nome de usuário e senha) de uma conta na organização que o portal usa para se comunicar com o Edge.
Se você ativar o SAML para a autenticação do Edge, vai poder configurar o portal para usar esse recurso ao fazer solicitações ao Edge. A configuração do portal para usar SAML cria automaticamente uma nova conta de usuário da máquina na organização do Edge que o portal usará para fazer solicitações ao Edge. Para mais informações sobre usuários de máquina, consulte Como usar SAML com tarefas automatizadas.
Para usar o suporte com SAML no portal, é preciso instalar e configurar o módulo SSO de borda no nó do servidor de gerenciamento de borda. O processo geral para ativar o SAML no portal é:
- Configure o SAML no Edge conforme descrito em Instalação e configuração do SAML para o Edge. Observação: a autenticação básica ainda precisa estar ativada no Edge para instalar o portal. Não desative a autenticação básica no Edge antes de configurar o portal para usar SAML.
- Instale o portal e verifique se a instalação está funcionando corretamente. Consulte Como instalar o portal do Edge para Serviços para Desenvolvedores de Nuvem Privada.
- Configure o SAML no portal.
- Agora é possível desativar a autenticação básica no Edge.
Como criar um usuário de máquina para o portal
Quando o SAML está ativado, o Edge oferece suporte à geração automatizada de tokens OAuth2 com o uso de usuários de máquinas. O usuário da máquina pode receber tokens OAuth2 sem precisar especificar uma senha. Isso significa que é possível automatizar completamente o processo de recebimento e atualização de tokens OAuth2.
O processo de configuração de SAML para o portal cria automaticamente um usuário de máquina na organização associada ao portal. Em seguida, o portal usa essa conta de usuário da máquina para se conectar ao Edge. Para mais informações sobre usuários de máquina, consulte Como usar SAML com tarefas automatizadas.
Sobre a autenticação para contas de desenvolvedor do portal
Ao configurar o portal para usar SAML, você permite que ele use o SAML para autenticação com o Edge a fim de que o portal possa fazer solicitações ao Edge. No entanto, o portal também é compatível com um tipo de usuário chamado desenvolvedores.
Os desenvolvedores compõem a comunidade de usuários que criam apps usando as APIs. Os desenvolvedores usam o portal para saber mais sobre suas APIs, registrar os apps que usam as APIs, interagir com a comunidade de desenvolvedores e conferir informações estatísticas sobre o uso dos apps em um painel.
Quando um desenvolvedor faz login no portal, é ele que é responsável por autenticar o desenvolvedor e aplicar permissões com base em papéis. O portal continua usando a autenticação básica com os desenvolvedores mesmo depois que você ativa o SAML entre o portal e o Edge. Para mais informações, consulte Como estabelecer comunicação entre o portal e o Edge.
Também é possível configurar o portal para usar SAML para autenticar desenvolvedores. Veja um exemplo de como ativar o SAML usando módulos Drupal de terceiros em https://community.apigee.com/articles/29201/sso- integration-via-saml-with-developer-portal.html.
Configure o SAML no portal para se comunicar com o Edge
Para configurar o SAML para o portal, crie um arquivo de configuração:
# IP address of Edge Management Server and apigee-sso node. IP1=22.222.22.222 # URL of Edge management API. MGMT_URL=http://$IP1:8080/v1 # Org associated with the portal. EDGE_ORG=myorg # Information about apigee-sso. # Externally accessible IP or DNS of apigee-sso. SSO_PUBLIC_URL_HOSTNAME=$IP1 SSO_PUBLIC_URL_PORT=9099 # Default is http. Set to https if you enabled TLS on apigee-sso. SSO_PUBLIC_URL_SCHEME=http # SSO admin credentials as set when you installed apigee-sso. SSO_ADMIN_NAME=ssoadmin SSO_ADMIN_SECRET=Secret123 # Default is "n" to disable SAML support. DEVPORTAL_SSO_ENABLED=y # The name of the OAuth client used to connect to apigee-sso. # The default client name is portalcli. PORTALCLI_SSO_CLIENT_NAME=portalcli # Oauth client password using uppercase, lowercase, number, and special chars. PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1 # Email address and user info for the machine user created in # the Edge org specified above by EDGE_ORG. # This account is used by the portal to make requests to Edge. # Add this email as an org admin before configuring the portal to use SAML. DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com DEVPORTAL_ADMIN_FIRSTNAME=DevPortal DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin DEVPORTAL_ADMIN_PWD=Abcdefg@1 # If set, the existing portal OAuth client is deleted and new one is created. # The default value is "n". # Set to "y" when you configure SAML and change the value of # any of the PORTALCLI_* properties. PORTALCLI_SSO_CLIENT_OVERWRITE=y
Para ativar o suporte a SAML no portal:
- Na interface do Edge, adicione o usuário de máquina especificado por DEVPORTAL_ADMIN_EMAIL à organização
associada ao portal como um Administrador da organização.
Observação: o usuário de máquina ainda não existe, mas será criado automaticamente na próxima etapa. - Execute o seguinte comando para configurar o SAML no portal:
> /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile
em que samlConfigFile é o arquivo de configuração do SAML. - Faça login no portal como administrador.
- No menu principal do Drupal, selecione Configuration > Dev Portal. A tela de configuração do portal será exibida, incluindo as configurações de SAML:
Observe que a caixa para Esta organização é ativada para SAML está marcada, o endpoint do módulo de SSO do Edge está preenchido, os campos Chave de API e Chave secreta do cliente do cliente Oauth do portal estão preenchidos e a mensagem Conexão bem-sucedida aparece sob o botão Conexão de teste.
- Pressione o botão Testar conexão para testar a conexão novamente a qualquer momento.
Para alterar esses valores posteriormente, atualize o arquivo de configuração e execute o comando novamente.
Desativar o SAML no portal
Se você desativar o SAML para comunicações entre o portal e o Edge, o portal não poderá mais fazer solicitações ao Edge. Os desenvolvedores conseguem fazer login no portal, mas não conseguem ver produtos ou criar apps.
Cuidado: se você desativar o SAML, reconfigure o portal para usar SAML ou, se o Edge ainda estiver configurado para oferecer suporte à autenticação básica, configure o portal para se comunicar com o Edge usando essa autenticação. Para mais informações sobre como usar a autenticação básica, consulte Como estabelecer comunicação entre o portal e o Edge.
Para desativar o SAML no portal:
- Edite o arquivo de configuração usado para configurar o SAM para definir:
DEVPORTAL_SSO_ENABLED=n - Configure o portal:
> /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile