Instalação de um conector personalizado

Depois de ter compilado e empacotado seu conector customizado, é necessário instalá-lo em sua instância do Discovery.

IBM Cloud Pak for Data IBM Software Hub

Essas informações se aplicam apenas a implementações instaladas.

O Discovery fornece um script denominado manage_custom_crawler.sh para instalação e desinstalação de conectores customizados. O script está localizado no diretório scripts do arquivo expandido custom-crawler-docs.zip, conforme descrito em Entendendo o arquivo custom-crawler-docs.zip.

Instalando um conector

É possível instalar o seu conector customizado em sua instância do Discovery executando as etapas a seguir.

  1. Assegure-se de que você tenha concluído todas as etapas para criar um conector customizado até e incluindo as etapas listadas em Compilando e empacotando o conector de exemplo.

  2. Execute o comando a seguir por meio do diretório em sua máquina local na qual você criou e compilou o seu conector customizado:

    bash scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {access token} deploy -n {crawler name} -f {built_connector_zip_file}

    onde você especifica valores para as seguintes variáveis:

    • endpoint: URL para sua instância de serviço. É possível obter esse valor na seção Informações de acesso da página de visão geral da instância de serviço no console administrativo IBM Cloud Pak for Data.
    • token de acesso: Token de portador necessário para acessar o ponto de extremidade. Você pode obter esse valor na mesma página que o ponto de extremidade.
    • nome do rastreador: (Opcional) Nome que você especificou para o rastreador.
    • {built_connector_zip_file} é o nome do arquivo que você criou em Compilação e empacotamento do conector de exemplo.

    Por exemplo:

    bash scripts/manage_custom_crawler.sh --endpoint https://mycpd.wd40.example.com/discovery/zen40-wd/instances/1638165624521059/api --token eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImVKcV9HY29NcHF5WUFJcVByZ0x0cERRZDNQcmRiTWo5TGg0X09WOEU4MlkifP.eyJ1aXQiOiIxMDAwMzMwOTk5IiwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOiJBZG1pbiIsInBlcm1pc3Npb25zIjpbImFkbWluaXN0cmF0b3IiLCJjYW5fcHJvdmlzaW9uIl0sImdyb3VwcyI6WzEwMDAwXSwic3ViIjoiYWRtaW4iLCJpc3MiOiJLTk9YU1NPIiwiYXVkIjoiRFNYIiwiaWF0IjoxNjQyNzAyMDA3fQ.5oymGw7pi6tAbTMW9rcdb62G95teR2-tKyznA_wjk_G698fbx1Zl73KZKyEWcTKtyX7IJ1Px5DPdophcqS9i3bPJowHy-ioVp6DML02mscZImhvZPra-e6gwUdhSB64KArmMClo1-kZG20EclNh6-oxR447Bjdsgp7IYpkmynmw0K6vPIqmzwEhr9gAK1vWLOoVd4EoiYNuxZaSFL5byJ0mnQxXzM14w3lKQHZ91WYVKc4JnuJiSVsdpGqVz1JNFmT8D9FBqJQ4uxtshnii0f1Yh-USKCbJmMPXicU8cDtJIfheBejwenfvejUTz5rgZgymYWrGvw3G2oOx_L1Yg-Q deploy -n awesome_crawler -f awesome_crawler.zip

    Em vez de especificar um token de acesso para autenticação, é possível especificar parâmetros de nome de usuário e senha. Para obter mais informações, consulte Entendendo o script manage_custom_crawler.sh.

Quando o rastreador personalizado é implantado, um ID de recurso é atribuído ao conector.

Verificando um conector instalado

Verifique se o conector foi implantado na instância Discovery fazendo login na ferramenta Discovery e verificando se o conector é exibido como uma opção na página Configurar coleção.

Usando um conector instalado no Discovery

Para usar o conector customizado instalado, siga as etapas listadas em Criando uma coleção. O conector customizado aparece na lista de conectores fornecidos em Configurando as origens de dados do Cloud Pak for Data. Para obter mais informações, consulte Usando um conector personalizado com a ferramenta Discovery.

Desinstalando um conector

Para desinstalar um conector personalizado de uma instância de Discovery, conclua as etapas a seguir:

  1. Opcional: se você não souber o ID do recurso, execute o seguinte comando para listar os conectores personalizados. As IDs de recursos dos conectores são retornadas.

    scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {token} list

  2. Execute o seguinte comando no diretório em que você extraiu o arquivo ZIP do conector personalizado para desinstalar o conector:

    scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {token} undeploy --id {crawler_resource_id}

    em que {crawler-resource-id} é a ID gerada para o rastreador quando ele é implantado.

    scripts/manage_custom_crawler.sh --endpoint {endpoint} --token {token} undeploy --id {crawler_resource_id}

Em vez de especificar um token de acesso para autenticação, é possível especificar parâmetros de nome de usuário e senha. Para obter mais informações, consulte Entendendo o script manage_custom_crawler.sh.

Entendendo o script manage_custom_crawler.sh

O script manage_custom_crawler.sh tem a documentação interna a seguir:

Watson Discovery Custom Crawler Manager

This script will help you deploy, manage, and undeploy your custom crawler for
Watson Discovery.

Subcommands:
  deploy        Add a new Custom Crawler to your Watson Discovery instance.
  undeploy      Undeploy your Custom Crawler by name.
  list          List all Custom Crawlers for your Watson Discovery instance.

Options:
  -e --endpoint         The endpoint URL for your cluster and add-on service instance
                        (`https://{cpd_cluster_host}:{port}/discovery/{release}/instances/{instance_id}/api`)
  -t --token            The authorization token of your Cloud Pak instance
  -u --user             The user name of your Cloud Pak instance
  -p --password         The user password of your Cloud Pak instance
                        If the password is not specified, the command line prompts to input
  -n --name             The name of the custom crawler to upload (deploy only)
  -f --file             The path of the custom crawler package to upload (deploy only)
  -i --id               The crawler_resource_id value to delete the custom crawler (undeploy only)
  --help                Show this message.

4.0.5 e versões anteriores apenas

Instalação de um conector na 4.0.5 e em versões anteriores

É possível instalar o seu conector customizado em sua instância do Discovery executando as etapas a seguir.

  1. Assegure-se de que você tenha concluído todas as etapas para criar um conector customizado até e incluindo as etapas listadas em Compilando e empacotando o conector de exemplo.

  2. Execute o comando a seguir por meio do diretório em sua máquina local na qual você criou e compilou o seu conector customizado:

    bash scripts/manage_custom_crawler.sh deploy -z {built_connector_zip_file}

    em que {built_connector_zip_file} é o nome do arquivo que você empacotou em Compilando e empacotando o conector de exemplo.

    Se a sua instância Discovery estiver sendo executada em Red Hat OpenShift, especifique o parâmetro -o ou --openshift com o script.

    Por exemplo:

    bash scripts/manage_custom_crawler.sh deploy -z myCrawler.zip -o true

Desinstalação de um conector na 4.0.5 e versões anteriores

Para desinstalar um conector customizado de uma instância do Discovery, execute o comando a seguir na raiz do diretório do custom-crawler-docs.zip descompactado:

bash scripts/manage_custom_crawler.sh undeploy -n {built_connector_name}

em que {build_connector_name} é o nome, não o arquivo zip, do conector instalado.

Se a sua instância IBM Watson® Discovery estiver sendo executada em Red Hat OpenShift, especifique o parâmetro -o ou --openshift com o script.

bash scripts/manage_custom_crawler.sh undeploy -n {built_connector_name} -o true

Entendendo o script manage_custom_crawler.sh em 4.0.5 e versões anteriores

O script manage_custom_crawler.sh tem a documentação interna a seguir:

Usage: ${BASH_SOURCE[0]} [--pathToZip PATH] [--properties PROPERTIES] [--xml XML]

Watson Discovery Custom Crawler Manager

This script will help you deploy, manage, and undeploy your custom crawler for
Watson Discovery.

Subcommands:
  deploy        Add a new Custom Crawler to your Watson Discovery instance.
  properties    Generate the properties file for your crawler.
  undeploy      Undeploy your Custom Crawler by name.
  list          List all Custom Crawlers for your Watson Discovery instance.

Options:
  -d --discovery        The name of the Watson Discovery instance
  -z --zipfile          The path to the zip file to be uploaded.
                        For deploy only.
  -x --xml              The path to the XML file to be uploaded.
                        For deploy only.
  -n --name             The name of the Custom Crawler to undeploy.
  -m --messages         The path to the properties file, used when doing a two part deploy.
                        For properties only.
  -o --openshift        Set flag to true if this is an OpenShift Cluster
  --help                Show this message.