Usando uma Configuração de Runtime

Ao criar uma sessão de notebook, você pode adicionar chaves de variáveis de ambiente personalizadas e URLs do repositório Git para uso em sessões de notebook.

Observação

Não nomeie chaves de variáveis de ambiente com os nomes de ambientes gerenciados de serviço na tabela a seguir, porque as chaves esperam determinados valores ou o serviço Data Science retorna automaticamente o valor.

Variáveis de Ambiente Gerenciado de Serviço

Nome da Chave da Variável

Descrição

Especificado por

TENANCY_OCID

OCID da tenancy à qual o notebook pertence.

Preenchido automaticamente pelo Data Science.

PROJECT_OCID

O OCID do projeto associado à sessão de notebook atual.

Preenchido automaticamente pelo Data Science.

PROJECT_COMPARTMENT_OCID

OCID do compartimento do projeto ao qual o notebook está associado.

Preenchido automaticamente pelo Data Science.

USER_OCID

OCID do Usuário.

Preenchido automaticamente pelo Data Science.

NB_SESSION_OCID

O OCID da sessão de notebook atual.

Preenchido automaticamente pelo Data Science.

NB_SESSION_COMPARTMENT_OCID

O OCID do compartimento da sessão de notebook atual.

Preenchido automaticamente pelo Data Science.

OCI_RESOURCE_PRINCIPAL_RPT_PATH

Caminho para o token do controlador de recursos do OCI.

Preenchido automaticamente pelo Data Science.

OCI_RESOURCE_PRINCIPAL_RPT_ID

Id do token do controlador de recursos do OCI.

Preenchido automaticamente pelo Data Science.

NB_ONCREATE_SCRIPT_URL

URL do script de ciclo de vida da sessão de notebook a ser executado durante a criação.

Especificado pelo usuário.

NB_ONACTIVATE_SCRIPT_URL

URL do script de ciclo de vida da sessão de notebook a ser executado durante a ativação.

Especificado pelo usuário.

NB_ONDEACTIVATE_SCRIPT_URL

URL do script de ciclo de vida da sessão de notebook a ser executado durante a desativação.

Especificado pelo usuário.

NB_ONDELETE_SCRIPT_URL

URL do script de ciclo de vida da sessão de notebook a ser executado durante a exclusão.

Especificado pelo usuário.

NB_SCRIPT_OUTPUT_LOG_NAMESPACE

Namespace do serviço Object Storage para logs de saída de script do ciclo de vida do notebook.

Especificado pelo usuário.

NB_SCRIPT_OUTPUT_LOG_BUCKET

Bucket do Object Storage para logs de saída de script do ciclo de vida do notebook.

Especificado pelo usuário.

SECURE_DATA_SESSION

Desative o download de arquivo do cliente JupyterLab e da API de download JupyterLab. Defina como Verdadeiro para desativar a funcionalidade de download.

Especificado pelo usuário.

SHM_SIZE Espaço de memória compartilhado, digite o tamanho da memória seguido pelas unidades: g para GB, m para MB e b para bytes. Por exemplo, digite 128g para 128 GB de espaço de memória compartilhada. Especificado pelo usuário.

Chaves de Variáveis de Ambiente Personalizadas

Além das variáveis fornecidas pelo sistema, você pode adicionar chaves de variável de ambiente personalizadas às sessões de notebook. Ao criar uma sessão de notebook, adicione variáveis personalizadas como pares de chave/valor na seção Configuração de tempo de execução.

Restrições de Par de Chave/Valor
  • Chaves e valores fazem distinção entre maiúsculas e minúsculas.

  • As chaves devem começar com letra ou sublinhado e só podem conter caracteres alfanuméricos e sublinhados.

  • O tamanho da chave é de no mínimo 2 e no máximo 32 caracteres.

  • O valor deve ter no mínimo 1 e no máximo 256 caracteres.

  • As chaves não podem começar com o namespace reservado oci_internal_ do serviço.

  • As chaves não podem ser variáveis gerenciadas pelo serviço.

Para uma sessão de notebook existente, desative as sessões de notebook. Em seguida, quando você ativar o notebook, adicione os pares de chave/valor na seção Configuração de runtime.

Usando Chaves de Variáveis de Ambiente Personalizadas para Gerenciar Scripts de Ciclo de Vida de Sessões de Notebook

Você pode usar os scripts de ciclo de vida da sessão de notebook para executar um script personalizado em diferentes estados de ciclo de vida da sessão de notebook da seguinte forma:

  • Criação

  • Ativar

  • Desativar

  • Exclusão

Para executar um script de ciclo de vida do notebook, informe uma chave gerenciada de serviço na seção Configuração do Runtime que indique o estado do ciclo de vida no qual o script será executado. No campo de valor correspondente, especifique o URI do arquivo do OCI Object Storage no qual o script de ciclo de vida foi submetido a upload.

O estado do notebook não é alterado até que o script seja concluído para excluir e desativar estados do ciclo de vida. Crie e ative scripts de ciclo de vida executados em paralelo com a sessão de notebook para que nenhum atraso inicial ocorra.

Fornecemos vários scripts de ciclo de vida de notebook de exemplo que podem ser alterados para atender a vários casos de uso.

Um grupo dinâmico e uma política de sessão de notebook para usar um controlador de recursos devem ser criados para usar scripts de ciclo de vida de notebook. As permissões de leitura devem ser concedidas ao grupo dinâmico de notebook para o bucket do Object Storage que contém os scripts de ciclo de vida.

As chaves variáveis do ambiente de script do ciclo de vida da sessão de notebook são:

NB_ONCREATE_SCRIPT_URL
NB_ONACTIVATE_SCRIPT_URL
NB_ONDEACTIVATE_SCRIPT_URL
NB_ONDELETE_SCRIPT_URL

Essas chaves devem ter a seguinte política de IAM adicionada para permitir que o Data Science leia objetos do bucket de scripts, como no seguinte exemplo:


allow dynamic-group <notebook_dyn_group> to manage objects in tenancy
 where all {target.bucket.name='<scripts_bucket>',
            any {request.permission='OBJECT_INSPECT',
                 request.permission='OBJECT_READ'}}

Para chaves gerenciadas de serviço correspondentes às chaves de script do ciclo de vida do notebook anteriores, o valor deve ser um URI de arquivo do OCI Object Storage para os scripts submetidos a upload. O formato do URI é https://objectstorage.region.oraclecloud.com/n/object-storage-namespace/b/bucket/o/filename. Você pode encontrar o URI do arquivo na seção Detalhes do Objeto.

As chaves variáveis do ambiente de script de saída do ciclo de vida da sessão de notebook são:

NB_SCRIPT_OUTPUT_LOG_NAMESPACE
NB_SCRIPT_OUTPUT_LOG_BUCKET

Essas chaves devem ter a seguinte política de IAM adicionada para permitir que o Data Science crie e faça upload de logs de saída no bucket de logs, como no seguinte exemplo:


allow dynamic-group <notebook_dyn_group> to manage objects in tenancy
 where all {target.bucket.name='<logs_bucket>',
            any {request.permission='OBJECT_CREATE'}}

Os logs de script de criação e ativação estão disponíveis dentro da sessão de notebooks no mesmo caminho da configuração de runtime no diretório /opt/log/odsc.log.

O upload do log ocorre com uma operação de desativação ou exclusão da sessão de notebook, que oferece a opção de verificar o status do processamento do script porque você perde o acesso à sessão de notebook. Isso não é suportado para criar e ativar scripts.

Usando uma Configuração de Runtime para Clonar um Repositório Git

Os repositórios Git podem ser clonados dentro de sessões de notebook usando uma configuração de runtime. Somente repositórios Git públicos podem ser clonados com essa abordagem. Para clonar repositórios Git privados, use chaves SSH para autenticação.

Você pode fazer com que o serviço clone um repositório Git em um diretório local de uma sessão de notebook e use o Git.

Restrições de Git
  • O notebook deve ter acesso à internet para que o repositório Git seja clonado.

  • Só há suporte para repositórios Git públicos.

  • São permitidos no máximo três URLs de repositórios Git.

  • O tamanho máximo de um URL é 256 caracteres.

Diretórios Relacionados ao Git nas Sessões de Notebook
  • Localize os clones dos repositórios Git no diretório /home/datascience/repos de uma sessão de notebook.
  • Para ver o status da clonagem, como sucesso, falha ou em andamento, vá para /opt/log/odsc.log.
  • Para ver logs detalhados, vá para /var/log/jupyterlab/runtime_config.log.

Acesse os logs em um terminal em uma sessão de notebook.

Para a sessão de notebook existente, desative as sessões de notebook. Em seguida, quando você ativar o notebook, adicione o URL do repositório Git na seção Configuração de Runtime.

Se você ativar uma sessão de notebook com novos URLs do repositório Git, qualquer URL listado na seção Configuração de Runtime, incluindo URLs anteriores das sessões de notebook desativadas, também serão clonados no diretório /home/datascience/repos do notebook.

Para remover um repositório clonado de uma sessão de notebook, você pode excluí-lo do diretório /home/datascience/repos da sessão de notebook.

Para substituir um clone antigo de um notebook desativado por um novo, exclua o URL do repositório Git indesejado listado na seção Configuração de Tempo de Execução, adicione o novo URL e, em seguida, a sessão de notebook.