Para poder implantar componentes personalizados no Oracle Cloud Infrastructure Functions, obtenha os nomes dos artefatos usados para implantação e verifique se você tem permissão para usá-los.

Para configurar sua instância para implantação do Oracle Cloud Infrastructure Functions, o administrador do tenancy concluiu as etapas em Configurar e Políticas para o Oracle Functions. Como parte do processo, eles criaram os artefatos a seguir. Peça ao administrador seus nomes, que você precisará ao concluir as etapas em Configurar Sua Conta de Usuário para o Oracle Functions:

• Os nomes da região e do compartimento a serem usados para suas funções.

• O nome do compartimento da rede virtual (VCN) do aplicativo de função. Normalmente, esse é o mesmo compartimento usado para funções.

• O nome da VCN a ser usada para o aplicativo de função.

Além disso, peça ao administrador para verificar se você pertence a um grupo que tem as permissões necessárias para desenvolvedores de funções, que inclui acesso a esses artefatos.

Para poder implantar pacotes de componentes personalizados no Oracle Cloud Infrastructure Functions, conclua estas etapas na console do Oracle Cloud Infrastructure:

1. Acesse a Console e, na barra superior, selecione a região na qual o compartimento de desenvolvimento da função está.

2. Você implantará no Oracle Cloud Infrastructure Functions por meio do Oracle Cloud Infrastructure Registry. Se você ainda não tiver um repositório de registro que possa usar, faça o seguinte para criar um.

   1. Clique em na parte superior esquerda para abrir o menu de navegação, clique em Serviços do Desenvolvedor, clique em Registro de Contêiner e, em seguida, na seção Escopo da Lista, selecione o compartimento que foi configurado para o desenvolvimento da função.

   2. Clique em Criar Repositório.

   3. Dê um nome ao repositório e clique em Criar Repositório.

3. Se você não tiver um aplicativo de funções para seus pacotes de componentes personalizados, crie um. Na página Serviços do Desenvolvedor, clique em Funções e, em seguida, clique em Criar Aplicativo. Forneça um nome, selecione uma VCN, selecione pelo menos uma sub-rede e clique em Criar.

   Se você não vir VCNs entre as quais escolher, talvez não esteja na região correta.

   Há limites para o número de aplicativos e funções. Para saber os limites padrão, consulte Limites de Funções na Documentação do Oracle Cloud Infrastructure .

4. Na página Aplicativos, clique no aplicativo que você usa para implantação de função, clique em Conceitos Básicos na seção Recursos e, em seguida, clique em Configuração Local.

   Conforme mostrado na captura de tela a seguir, a página exibe vários comandos que você precisará usar para configurar seu computador local e implantar seu pacote de componentes personalizados. Copie e salve os comandos das etapas 3 a 7.

   Você irá usá-los depois de instalar o software necessário na sua máquina local e estará pronto para implantar seus componentes personalizados. Se preferir, marque essa página para que você possa retornar a ela quando precisar usar os comandos.

   Não execute esses comandos agora. Basta copiá-los.

   
   
   Descrição da ilustração fn-local-configuração-commands.png
   

5. No comando copiado, semelhante ao seguinte, altere [OCIR-REPO] para o nome do seu repositório de registro.

   fn update context registry phx.ocir.io/devdigital/[OCIR-REPO]

6. Clique no ícone Perfil no canto superior direito e clique em Definições do Usuário para ir até a página Detalhes do Usuário.

7. Na próxima etapa, você criará um arquivo PEM que precisará armazenar em uma pasta .oci na sua máquina local. Se a sua pasta home na máquina local não tiver esse diretório, crie um em uma janela de terminal.

   • Linux e Mac:

     cd ~
     mkdir .oci

   • Janelas:

     cd C:\Users\<your-user-name>
     mkdir .oci

8. Você precisa de um arquivo PEM público e privado para acesso seguro. Se você ainda não tiver configurado um para sua conta de usuário, em Detalhes do Usuário na Console, clique em Chaves de API na seção Recursos e clique em Adicionar Chave de API.

   Salve o arquivo de chave privada (o arquivo PEM) no diretório .oci na pasta home.

9. Anote a Impressão Digital associada à chave de API. Quando você tiver várias chaves de API, deverá saber qual impressão digital usar para cada arquivo PEM privado.

10. Se você ainda não tiver configurado um arquivo config para a impressão digital na sua máquina local, na seção Chaves de API, execute estas etapas:

    1. Clique em na linha da impressão digital da sua chave de API e, em seguida, clique em Exibir arquivo de Configuração.

    2. Copie o conteúdo da Visualização do Arquivo de Configuração.

    3. Na pasta .oci da sua máquina local (a mesma pasta na qual você salvou seu arquivo de chave privada), crie um arquivo com o nome config e cole o conteúdo copiado no arquivo.

11. No arquivo config, altere a propriedade key_file para apontar para o local do arquivo PEM privado. Por exemplo: key_file=/home/joe/.oci/my-private.pem

12. Se você não tiver um token de autenticação, clique em Tokens de Autenticação no menu Recursos e, em seguida, clique em Gerar Token. Copie o token de autenticação imediatamente para um local seguro de onde poderá recuperá-lo posteriormente, porque você não o verá novamente na console. Use o token de autenticação como senha quando acessar para enviar seu pacote de componentes personalizados ao registro do Oracle Infrastructure para implantação.

Instale o cURL, a interface de linha de comando (CLI), o Fn e o Docker na sua máquina local para permitir a implantação no Oracle Cloud Infrastructure Functions. Se sua máquina for executada no Windows, execute uma das seguintes opções para usar o Fn:

• Instale o Fn e o Docker no Linux em um Oracle VM VirtualBox seguindo as etapas deste tópico.

• Instale o Docker e o Fn no Windows e, em seguida, instale o subsistema Linux para Windows conforme descrito em Como: Executar o cliente Fn no Windows e estabelecer conexão com um servidor Fn remoto.

• Implante seus componentes personalizados no Cloud Shell. Consulte Cloud Shell na Documentação do Oracle Cloud Infrastructure.

Para configurar sua máquina local:

1. (Somente Windows na VM) Se quiser usar um convidado do Linux no Oracle VM VirtualBox para implantar seu pacote de componentes personalizados no Oracle Cloud Infrastructure Functions, siga estas etapas:

   1. Instale o VirtualBox em https://www.virtualbox.org/.

   2. Faça download de um ISO Linux. Por exemplo, para obter o ISO para Ubuntu-Mate, vá para https://ubuntu-mate.org/download/ e clique em 64-bit PCs/Macs.

   3. No VirtualBox, crie uma máquina virtual com base no ISO. Você encontra as instruções para criar uma máquina virtual Ubunto-Mate em https://itsfoss.com/install-linux-in-virtualbox/. Esse será o seu convidado do Linux.

   4. Inicie o convidado do Linux.

   5. Em uma janela de terminal, execute este comando:

      sudo apt-get update

      Isso atualiza as listas de pacotes para novos pacotes e pacotes que precisam de upgrade.

      Dica:

      Para abrir uma janela de terminal no Ubuntu, pressione Ctrl-Alt-T.

   6. Para copiar e colar em uma janela de terminal, você precisará das adições de convidados. Faça download do http://download.virtualbox.org/virtualbox/<release>/VBoxGuestAdditions_<release>.iso e instale e configure as adições usando as instruções em https://itsfoss.com/virtualbox-guest-additions-ubuntu/

      Certifique-se de configurar Devices > Drag and Drop para bidirectional.

   7. Digite esse comando em uma janela de terminal para instalar node.js e npm no convidado.

      sudo apt install npm

   8. Arraste a pasta .oci no seu diretório home da sua máquina local para a pasta home do convidado do Linux.

      Como é um arquivo oculto, pressione Ctrl-H ou selecionar View > Show Hidden Files na pasta home para vê-lo.

   9. Na pasta .oci do convidado do Linux, abra o arquivo config e altere key_file para apontar para o local do arquivo no seu convidado do Linux. Por exemplo: key_file=/home/joe/.oci/my-private.pem

   10. Conclua as etapas restantes deste tópico no convidado do Linux.

2. (Somente Mac) Se você ainda não tiver feito isso, instale o Homebrew para permitir que você instale o cURL, a CLI do OCI e o Fn. Consulte https://docs.brew.sh/Installation. Se preferir, você poderá usar os comandos MacPorts equivalentes.

3. Se o acesso à Internet for por meio de uma VPN, você poderá precisar configurar proxies. Por exemplo :

   export http-proxy = http://<external_ip>:80
   export https-proxy = http://<external_ip>:80
   export no_proxy = localhost,127.0.0.1,<list>
   export noproxy = localhost,127.0.0.1,<list>
   export no_proxy = localhost,127.0.0.1,<list>
   # Example for apt
   nano /etc/apt/apt.conf
   Acquire::http::Proxy "http://<external_ip>:80";
   Acquire::https::Proxy "http://<external_ip>:80";

4. Execute o comando apropriado para trazer os pacotes atualizados.

   • Linux:

     sudo apt update && sudo apt upgrade

   • Mac:

     brew update && brew upgrade

5. (Somente Linux) Você usará o cURL para instalar o OCI e o Fn. Digite esse comando em uma janela de terminal. A última instrução é verificar se ela foi instalada com sucesso.

   sudo apt install curl
   curl --version

6. O Fn usa a CLI do OCI para implantar os componentes personalizados no Oracle Cloud Infrastructure Functions. Execute o comando apropriado para instalar a CLI e aceite todos os padrões.

   • Linux:

     bash -c "$(curl -L https://raw.githubusercontent.com/oracle/oci-cli/master/scripts/install/install.sh)"

   • Mac:

     brew update && brew install oci-cli

   • Windows (se estiver usando o subsistema Linux no Windows): Siga as etapas do Windows em Início Rápido na Documentação do Oracle Cloud Infrastructure.

7. Em Configurar Sua Conta de Usuário para o Oracle Functions, você criou um arquivo config. Agora você precisa configurar a CLI para usar esse arquivo. Abra uma nova janela de terminal, execute esse comando, forneça o local do seu arquivo config e digite n para as perguntas restantes (o seu arquivo config já tem as definições necessárias).

   oci setup config

   Por exemplo :

   $ oci setup config
       This command provides a walkthrough of creating a valid CLI config file.
       ...
   
   Enter a location for your config [/home/joe/.oci/config]:
   Config file: /home/joe/.oci/config already exists. Do you want add a profile here? (If no, you will be prompted to overwrite the file) [Y/n]: n
   File: /home/joe/.oci/config already exists. Do you want to overwrite (Removes existing profiles!!!)? [y/N]: n

8. Você precisa do Docker 17.10.0-ce ou mais recente para enviar o pacote de componentes personalizados para o registro.

   • No Ubuntu, as instruções de instalação estão em https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository

   • No Mac, as instruções de instalação estão em https://docs.docker.com/docker-for-mac/install/

   Consulte https://docs.docker.com/engine/install/linux-postinstall/ se não quiser prefaciar o comando docker com sudo.

9. Se você estiver usando VPN, siga as instruções em https://docs.docker.com/network/proxy/

   Se você estiver usando o subsistema Linux no Windows, poderá definir os proxies na página Recursos, nas Definições do Docker Desktop.

10. Verifique se o Docker está em execução. Não será possível iniciar o Fn, que você instala em seguida, se o Docker não estiver em execução.

11. Você usará o Fn, que é uma plataforma leve de funções sem servidor baseada no Docker, para configurar o contexto e implantar o pacote. Se você ainda não tiver instalado o Fn, siga as instruções para instalá-lo, iniciar o servidor Fn e testar a instalação em https://fnproject.io/tutorials/install/

    Não é necessário configurar o contexto ou definir o registro nesse momento. Você fará isso quando concluir as etapas em Implantar os Componentes Personalizados no Oracle Cloud Infrastructure Functions.

Para poder implantar um pacote de componentes personalizados no Oracle Cloud Infrastructure Functions, adicione os arquivos func.js e func.yaml, adicione uma dependência do desenvolvedor para o fnproject FDK e instale o FDK.

1. Se você tiver usado o comando bots-node-sdk init para criar seu pacote de componentes personalizados, ele poderá ter criado um arquivo chamado Dockerfile na pasta superior. Se sim, você deve excluí-lo. Caso contrário, sua implantação falhará.

2. Na pasta superior do seu pacote de componentes personalizados (a pasta que contém main.js), crie um arquivo com o nome func.js e adicione o código a seguir. Esse é o arquivo que o Oracle Cloud Infrastructure Functions chamará.

   /***
    
     This function handles an invocation that sets the "Oracle-Bots-Fn-Path" header to determine which component to invoke or if metadata should be returned.
    
   ***/
    
   const fdk = require('@fnproject/fdk');
   const OracleBotLib = require('@oracle/bots-node-sdk/lib');
   const path = require("path");
    
   const BOTS_FN_PATH_HEADER = "Oracle-Bots-Fn-Path";
   const METADATA_PATH = "metadata";
   const COMPONENT_PREFIX = "components/";
    
   let shell;
   let componentsRegistry;
    
   const getComponentsRegistry = function (packagePath) {
       let registry = require(packagePath);
       if (registry.components) {
           return OracleBotLib.ComponentRegistry.create(registry.components, path.join(process.cwd(), packagePath));
       }
       return null;
   }
    
   componentsRegistry = getComponentsRegistry('.');
   if (componentsRegistry && componentsRegistry.getComponents().size > 0) {
       shell = OracleBotLib.ComponentShell({logger: console}, componentsRegistry);
       if (!shell) {
           throw new Error("Failed to initialize Bots Node SDK");
       }
   } else {
       throw new Error("Unable to process component registry because no components were found in package: " + packagePath);
   }
    
   const _handle = function (input, ctx) {
       let botsFnPath = ctx.getHeader(BOTS_FN_PATH_HEADER);
       if (!botsFnPath) {
           throw new Error("Missing required header " +  BOTS_FN_PATH_HEADER);
       } else if (botsFnPath === METADATA_PATH) {
           return shell.getAllComponentMetadata();
       } else if (botsFnPath.startsWith(COMPONENT_PREFIX)) {
           let componentName = botsFnPath.substring(COMPONENT_PREFIX.length);
           if (!componentName) {
               throw new Error("The component name is missing from the header " + BOTS_FN_PATH_HEADER + ": " + botsFnPath);
           }
           return new Promise((resolve) => {
               let callback = (err, data) => {
                   if (!err) {
                       resolve(data);
                   } else {
                       console.log("Component invocation failed", err.stack);
                       throw err;
                   }
               };
               shell.invokeComponentByName(componentName, input, {logger: () => console}, callback);
               });
       }
   };
    
   fdk.handle(function (input, ctx) {
       try {
           return _handle(input, ctx);
       } catch (err) {
           console.log("Function failed", err.stack);
           throw err;
       }
   });

3. Na mesma pasta, crie um arquivo com o nome func.yaml e adicione o seguinte conteúdo:

   schema_version: 20180708
   name: <custom component package name>
   version: 0.0.1
   runtime: [node11|node14]
   build_image: [fnproject/node:11-dev|fnproject/node:14-dev]
   run_image: [fnproject/node:11|fnproject/node:14]
   entrypoint: node func.js

4. Na propriedade name, altere <custom component package name> para o nome do seu pacote de componentes personalizados e salve suas alterações. O nome geralmente é o mesmo especificado no arquivo package.json.

   O nome não deve ter mais de 255 caracteres e só pode conter letras, números, _ e -.

5. Defina estas propriedades:

   • runtime: A linguagem e a versão do Nó. Especifique node11 ou node14.

   • build_image: A imagem base do build-time que contém as bibliotecas e ferramentas específicas do idioma para criar funções executáveis. Especifique fnproject/node:11-dev ou fnproject/node:14-dev.

   • run_image: A imagem base do runtime que fornece o ambiente de runtime específico do idioma no qual executar funções executáveis. Especifique fnproject/node:11 ou fnproject/node:14.

6. Em uma janela de terminal, vá para a pasta superior do pacote e digite este comando para instalar o FDK e adicioná-lo como dependência de pacote no arquivo package.json:

   npm install --save-dev @fnproject/fdk

7. (Opcional – Somente Linux, Mac e subsistema Linux no Windows) Execute este comando para instalar dependências de pacotes:

   npm install

   Observe que, se a pasta node_modules não existir, o comando fn deploy que você executar mais tarde chamará npm install para você.

8. (Somente Windows VM) Conclua estas etapas para copiar seu código de componente personalizado no seu convidado do Linux para implantação:

   1. Arraste e solte a pasta de nível superior no convidado do Linux.

   2. Em uma janela de terminal, vá para a pasta de nível superior (a que contém main.js) e digite esse comando para adicionar permissões de execução para a pasta.

      chmod 755 components

   3. Exclua a pasta node_modules para garantir que você não tenha módulos de nó dependentes da plataforma.

   4. (Opcional) Execute esse comando para reinstalar as dependências do módulo de nó.

      npm install

      Observe que, se a pasta node_modules não existir, o comando fn deploy que você executar posteriormente chamará npm install para você.

Agora você está pronto para concluir as etapas em Implantar os Componentes Personalizados no Oracle Cloud Infrastructure Functions.

Depois de criar o arquivo func.js, adicionar o fnproject às dependências de desenvolvimento e instalar as dependências, conforme descrito em Modificar o Pacote de Componentes Personalizados para o Oracle Functions, você estará pronto para implantar uma imagem do Docker do pacote de componentes no Oracle Cloud Infrastructure Functions.

Quando tiver concluído as etapas em Configurar sua Conta de Usuário para o Oracle Functions, você terá copiou os comandos da Configuração Local, na página Conceitos Básicos, para as etapas de 3 a 7. Você usará esses comandos copiados para implantar seus componentes personalizados.

Se você estiver usando o Cloud Shell, use os comandos semelhantes mostrados em Configuração do Cloud Shell.

Para implantar os componentes personalizados:

1. Certifique-se de que o Docker e o servidor Fn estejam em execução.

2. Em uma janela de terminal, vá para o diretório superior do seu pacote de componentes personalizados e digite os comandos copiados equivalentes para configurar o contexto.

   fn create context <context> --provider oracle
   fn use context <context>
   fn update context oracle.compartment-id <compartment-ocid>
   fn update context api-url https://functions.<region-identifier>.oci.oraclecloud.com

   Você não precisará executar esses comandos novamente até precisar alterar as configurações de contexto.

   Se você receber o erro "Fn: error replace file with tempfile" quando alterar o contexto, edite manualmente ~/.fn/config.yaml e altere o contexto nesse arquivo.

3. Se seu arquivo de configuração tiver vários perfis, digite esse comando para apontar para o perfil criado em Configurar Sua Conta de Usuário para o Oracle Functions.

   fn update context oracle.profile <profile-name>

4. Para apontar o repositório de registro criado em Configurar Sua Conta de Usuário para o Oracle Functions, digite seu comando copiado que seja equivalente ao seguinte. Caso ainda não tenha feito isso, altere [OCIR-REPO] para o nome do seu repositório.

   fn update context registry <region-key>.ocir.io/<tenancy-namespace>/[OCIR-REPO]

   Você não precisará executar esse comando novamente até precisar alterar a configuração do repositório.

5. Se você não tiver acessado o Docker na sua sessão atual, execute o comando copiado equivalente ao mostrado aqui.

   Quando ele solicitar uma senha, digite seu token de autenticação, que é o token obtido durante a conclusão das etapas em Configurar Sua Conta de Usuário para o Oracle Functions.

   docker login -u '<tenancy-namespace>/<user-name>' <region-key>.ocir.io

6. Para implantar os componentes personalizados, execute este comando:

   fn deploy --app <application>

   Se você vir a mensagem a seguir, abra o arquivo .oci/config e verifique se fingerprint mostra a impressão digital correta para o key_file especificado. Caso contrário, vá para as definições do usuário na Console, clique em Chaves de API, exiba o arquivo de configuração da impressão digital correta e substitua o conteúdo do seu arquivo de configuração pelo conteúdo exibido.

   Fn: Service error:NotAuthenticated. The required information to complete
   authentication was not provided or was incorrect.. 
   http status code: 401.

Seus componentes personalizados estão prontos para uso em uma habilidade, conforme descrito em Adicionar Serviço do Oracle Functions.