Observação:
- Este tutorial requer acesso ao Oracle Cloud. Para se inscrever em uma conta gratuita, consulte Conceitos Básicos do Oracle Cloud Infrastructure Free Tier.
- Ele usa valores de exemplo para credenciais, tenancy e compartimentos do Oracle Cloud Infrastructure. Ao concluir seu laboratório, substitua esses valores por valores específicos do seu ambiente de nuvem.
Usar o OCI Functions e o Python para Abrir Tíquetes no Jira Service Management
Introdução
O tutorial a seguir é endereçado aos usuários da Oracle Cloud Infrastructure (OCI) que usam o serviço OCI Monitoring e o Jira Service Management para abrir tíquetes e rastrear incidentes. Digamos que você tenha uma instância do OCI e queira saber quando a instância ficará inativa inesperadamente devido a algum erro. Você quer ser notificado e um ticket aberto no Jira Service Management imediatamente para que o engenheiro em serviço possa começar a investigar e corrigir o problema o mais rápido possível. Usando o serviço OCI Functions, os tickets podem ser abertos automaticamente no Jira Service Management quando problemas são detectados com os sistemas da sua organização.
Objetivos
-
Saiba como usar o OCI Functions.
-
Integre o OCI Functions, o OCI Notifications e o OCI Monitoring ao Jira Service Management.
Pré-requisitos
-
Inscreva-se ou entre na sua conta do OCI.
-
Acesso ao Jira Service Management.
-
Faça download da função Python aqui: JSM.zip.
-
(Opcional) Um usuário técnico do Jira Service Management.
Tarefa 1: Criar uma Rede Virtual na Nuvem
Uma rede virtual na nuvem (VCN) é uma rede que você define no OCI. Ele inclui sub-redes, tabelas de roteamento e gateways.
-
Clique no menu de serviços
perto do canto superior esquerdo da Console do OCI.
-
Em Networking, selecione Virtual Cloud Networks.
-
Na página Redes Virtuais na Nuvem, clique em Iniciar Assistente de VCN.
-
Selecione Create VCN with Internet Connectivity e clique em Start VCN Wizard.
-
Conclua a configuração da VCN, clique em Próximo e Criar.
Tarefa 2: Criar um Grupo Dinâmico
Os grupos dinâmicos permitem que você grupo instâncias do OCI Compute como atores principais (semelhantes aos grupos de usuários).
Observação: você precisa de privilégios de Administrador para criar grupos dinâmicos.
-
No menu Services, navegue até Identity & Security, Identity e clique em Dynamic Groups.
-
Clique em Criar Grupo Dinâmico.
-
Informe um Nome e uma Descrição significativos.
-
Na seção Regra 1, adicione a seguinte linha:
ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1', instance.compartment.id = 'ocid1.compartment.oc1'}
Observação: Substitua o ID do compartimento pelo ID do compartimento desejado.
-
Clique em Criar.
Tarefa 3: Criar Políticas do OCI IAM
O Oracle Cloud Infrastructure Identity and Access Management (OCI IAM) permite controlar quem tem acesso aos recursos de nuvem. Para que essa integração funcione, precisamos conceder acesso aos serviços Function as a service (FaaS) (function service) para o vault, repos e vários outros serviços.
-
No menu Serviços, navegue até Identidade e Segurança, Identidade e clique em Políticas.
-
Clique em Criar Política.
-
Informe um Nome e uma Descrição apropriados e certifique-se de escolher o compartimento correto (neste exemplo, usaremos o compartimento chamado
DEV
). -
Na seção Criador de Políticas, certifique-se de ativar Mostrar editor manual e adicionar as seguintes linhas:
Allow service faas to read repos in tenancy Allow service faas to read secret-family in compartment DEV Allow service faas to read vaults in compartment DEV Allow service faas to use keys in compartment DEV Allow service faas to use apm-domains in compartment DEV Allow dynamic-group DGNAME to read secret-family in compartment DEV Allow dynamic-group DGNAME to read vaults in compartment DEV Allow dynamic-group DGNAME to use keys in compartment DEV
Observação: Substitua o nome do grupo dinâmico (
DGNAME
) e o nome do compartimento (DEV
) pelos nomes desejados. -
Clique em Criar.
Tarefa 4: Criar um Repositório para Armazenar a Função
O OCI Container Registry permite armazenar, compartilhar e gerenciar imagens de contêiner (como imagens do Docker) em um registro gerenciado pela Oracle.
-
Vá para a Console do OCI, abra o menu de serviço e clique em Developer Services. Em Containers, clique em Container Registry.
-
Clique em Criar Repositório.
-
Na caixa de diálogo Criar Repositório, especifique Compartimento e Nome do Repositório de sua escolha e deixe-o como Privado.
-
Clique em Criar Repositório.
Tarefa 5: Criar um Vault para Armazenar o Usuário e o Token da API para o Log-in do Jira Service Management
O Oracle Cloud Infrastructure Vault é um serviço de gerenciamento de chaves que armazena e gerencia chaves de criptografia principais e segredos para acesso seguro aos recursos.
-
Abra o menu de serviço, clique em Identidade e Segurança e Vault.
-
Clique em Criar Vault.
-
Na caixa de diálogo Criar Vault, selecione o compartimento de sua escolha e informe um Nome apropriado de sua escolha. Você também pode escolher se deseja torná-lo privado ou não.
Observação: Você não pode alterar o tipo de vault após a criação do vault.
-
Quando terminar, clique em Criar Vault.
Observação: Salve o Jira Service Management
api-token
eapi-user
separadamente no vault.
Tarefa 6: Criar um Aplicativo
-
Abra o menu de serviço e clique em Serviços ao Desenvolvedor. Em Funções, clique em Aplicativos.
-
Clique em Criar Aplicativo.
-
Na janela Criar Aplicativo, digite o Nome do aplicativo (por exemplo,
Jira-Ticketing
), selecione a VCN criada na Tarefa 1 e selecione a sub-rede pública. -
Clique em Criar.
Tarefa 7: Implantar a Função
Esta tarefa usará o arquivo compactado zip que pode ser baixado da seção Pré-requisitos.
-
Selecione o aplicativo recém-criado na Tarefa 6 na lista.
-
Nas janelas Aplicativo, siga as etapas disponíveis na opção Introdução em Recursos.
Observação:
-
Neste tutorial, usamos a configuração do OCI Cloud Shell.
-
Na etapa 4 da configuração, certifique-se de especificar o nome do repositório criado na Tarefa 4.
-
-
Depois que você clicar em Iniciar Cloud Shell, uma nova janela de shell pequena será exibida na parte inferior da página. No canto superior direito dessa janela, clique no menu de engrenagem e selecione Fazer Upload
-
Arraste e solte o arquivo
jsm-ticket-function.zip
que será submetido a upload no diretório home. -
Descompacte o arquivo usando o comando a seguir.
unzip jsm-ticket-function.zip
-
Alterne para o diretório de funções usando o comando
cd jsm-ticket-function
e prossiga com as etapas descritas na Console do OCI.
Tarefa 8: Editar a Configuração da Função
As funções têm alguns parâmetros configuráveis que devem ser editados para que a função funcione corretamente.
-
Na Console do OCI, vá para o aplicativo criado na Tarefa 6 e selecione Funções no lado esquerdo em Recursos.
-
Clique no nome da função jsm-ticket-function.
-
Clique em Configuração em Recursos. Você poderá ver cinco chaves:
api-token
,api-user
,service_desk_id
,request_type_id
evault_ocid
.Todas essas chaves devem ser editadas com sua configuração:
-
api-token: O nome do segredo do vault no qual o api-token da conta de usuário da qual o ticket é criado em nome é armazenado. Para obter mais informações, consulte Gerenciar tokens de API para sua conta Atlassian.
-
api-user: O nome do segredo do vault era o endereço de e-mail do usuário do qual o ticket será criado em nome é armazenado.
-
service_desk_id: Projeto no qual o ticket será criado.
-
request_type_id: Tipo de solicitação como o ticket será criado (Deve ter um título e uma descrição).
-
vault_ocid: vault_ocid em que os segredos do api-token e do api-user são armazenados.
A maneira rápida e fácil de obter service_desk_id e request_type_id é visitar o portal que você deseja usar e verificar os URLs. Por exemplo, vá para um portal e clique em uma solicitação para gerar e você verá um URL como:
https://somewhere.atlassian.net/servicedesk/customer/portal/10/group/229/create/664
Os números lá são:
- 10: O portal/servicedesk.
- 229: O grupo pelo qual a solicitação está sendo recebida (usado apenas pela navegação, você não se importa com isso no REST).
- 664: O id do tipo de solicitação no qual cliquei.
-
Tarefa 9: Inscrever a Função em um Tópico
-
Abra o menu de serviço e clique em Serviços ao Desenvolvedor. Em Integração de Aplicativos, clique em Notificações.
Observação: Certifique-se de estar no compartimento direito.
-
Clique em Criar Tópico.
-
Digite um nome apropriado e clique em Criar.
-
Depois que o tópico for criado, selecione-o na lista de tópicos.
-
Na janela Tópicos, selecione Assinaturas do lado esquerdo em Recursos e clique em Criar Assinatura.
-
Na janela Criar Assinatura, selecione o protocolo a ser Funções, selecione o compartimento, o aplicativo e a função criada na Tarefa 6.
-
Clique em Criar.
Tarefa 10: Criar um Alarme para a Métrica Desejada que você precisa Monitorar
Você pode criar vários tipos de alarmes. Neste tutorial, escolhemos um alarme de ausência.
-
Abra o menu de serviço e clique em Observação & Gerenciamento. Em Monitoring, clique em Definições de Alarme.
-
Clique em Criar Alarme.
-
Na página Criar alarme, em Definir alarme, digite ou atualize as definições de alarme.
-
Em Definir Notificações de Alarme, certifique-se de selecionar o tópico criado na Tarefa 9.
-
Selecione o Formato da Mensagem como Enviar mensagens Pretty JSON (texto não processado com quebras de linha).
-
Clique em Salvar alarme.
Links Relacionados
Confirmações
-
Autor - Dragos Nicu (Engenheiro Sênior de Nuvem)
-
Colaborador - Gabriel Feodorov (Engenheiro Sênior de Nuvem)
Mais Recursos de Aprendizagem
Explore outros laboratórios em docs.oracle.com/learn ou acesse mais conteúdo de aprendizado gratuito no canal Oracle Learning YouTube. Além disso, visite education.oracle.com/learning-explorer para se tornar um Oracle Learning Explorer.
Para obter a documentação do produto, visite o Oracle Help Center.
Use OCI Functions and Python to Open Tickets in Jira Service Management
F76126-03
October 2024