Conexión con Neptune mediante la consola de Gremlin con firma de Signature Version 4

La forma en que se conecte a Amazon Neptune mediante la consola Gremlin con la autenticación Signature Version 4 depende de si utiliza la TinkerPop versión superior 3.4.11 o anterior. En cualquiera de los casos, estos son los requisitos previos:

• Debe tener las IAM credenciales necesarias para firmar las solicitudes. Consulte Uso de la cadena de proveedores de credenciales predeterminada en AWS SDK for Java Guía para desarrolladores.

• Debe tener instalada una versión de consola de Gremlin que sea compatible con la versión del motor de Neptune que utiliza su clúster de base de datos.

Si usa credenciales temporales, estas caducan después de un intervalo específico, al igual que el token de sesión, por lo que debe actualizar su token de sesión cuando solicite nuevas credenciales. Consulte Uso de credenciales de seguridad temporales para solicitar acceso a AWS recursos de la Guía IAM del usuario.

Si necesita ayuda para conectarse medianteSSL/TLS, consulteSSL/configuración TLS.

Usar TinkerPop 3.4.11 o superior para conectarse a Neptune con la firma Sig4

Con la versión TinkerPop 3.4.11 o superior, utilizaráshandshakeInterceptor(), que proporciona una forma de conectar un firmante Sigv4 a la conexión establecida por el comando. :remote Al igual que con el enfoque utilizado para Java, es necesario configurar el objeto Cluster manualmente y, a continuación, pasarlo al comando :remote.

Tenga en cuenta que esto es muy diferente de la situación típica en la que el comando :remote utiliza un archivo de configuración para formar la conexión. El enfoque del archivo de configuración no funciona porque handshakeInterceptor() debe configurarse mediante programación y no puede cargar su configuración desde un archivo.

Conecta la consola Gremlin (TinkerPop 3.4.11 y superior) con la firma Sig4

1. Inicie la consola de Gremlin:

   $ bin/gremlin.sh

2. En el símbolo del sistema de gremlin>, instale la biblioteca amazon-neptune-sigv4-signer (esto solo debe hacerse una vez para la consola):

   :install com.amazonaws amazon-neptune-sigv4-signer 2.4.0

   Si tienes problemas con este paso, puede ser útil consultar la documentación sobre la TinkerPop configuración de Grape.

   nota

   Si utilizas un HTTP proxy, es posible que en este paso se produzcan errores si el :install comando no se completa. Para solucionar este problema, ejecute los siguientes comandos para informar a la consola acerca del proxy:

   System.setProperty("https.proxyHost", "(the proxy IP address)")
   System.setProperty("https.proxyPort", "(the proxy port)")

3. Importe la clase necesaria para gestionar el inicio de sesión en handshakeInterceptor():

   :import com.amazonaws.auth.DefaultAWSCredentialsProviderChain
   :import com.amazonaws.neptune.auth.NeptuneNettyHttpSigV4Signer

4. Si utiliza credenciales temporales, también tendrá que proporcionar su token de sesión de la siguiente manera:

   System.setProperty("aws.sessionToken","(your session token)")

5. Si no ha establecido las credenciales de su cuenta de otro modo, puede asignarlas de la siguiente manera:

   System.setProperty("aws.accessKeyId","(your access key)")
   System.setProperty("aws.secretKey","(your secret key)")

6. Construya manualmente el objeto Cluster para conectarlo a Neptune:

   
   cluster = Cluster.build("(host name)")  \
                    .enableSsl(true) \
                    .handshakeInterceptor { r ->  \
                      def sigV4Signer = new NeptuneNettyHttpSigV4Signer("(Amazon region)", \
                                        new DefaultAWSCredentialsProviderChain()); \
                      sigV4Signer.signRequest(r); \
                      return r; } \
                    .create()

   Para obtener ayuda para encontrar el nombre de host de una instancia de base de datos de Neptune, consulte Conexión a los puntos de conexión de Amazon Neptune.

7. Establezca la conexión :remote mediante el nombre de la variable del objeto Cluster en el paso anterior:

   :remote connect tinkerpop.server cluster

8. Introduzca el siguiente comando para cambiar al modo remoto. Esto envía todas las consultas de Gremlin a la conexión remota:

   :remote console

Uso de una versión TinkerPop anterior a la 3.4.11 para conectarse a Neptune con la firma Sig4

Con la TinkerPop versión 3.4.10 o inferior, utilice la amazon-neptune-gremlin-java-sigv4 biblioteca proporcionada por Neptune para conectar la consola a Neptuno con la firma Sigv4, tal y como se describe a continuación:

Conecta la consola Gremlin (TinkerPop versiones anteriores a la 3.4.11) con la firma Sig4

1. Inicie la consola de Gremlin:

   $ bin/gremlin.sh

2. En el símbolo del sistema de gremlin>, instale la biblioteca amazon-neptune-sigv4-signer (esto solo debe hacerse una vez para la consola):

   :install com.amazonaws amazon-neptune-sigv4-signer 2.4.0

   nota

   Si utilizas un HTTP proxy, es posible que en este paso se produzcan errores si el :install comando no se completa. Para solucionar este problema, ejecute los siguientes comandos para informar a la consola acerca del proxy:

   System.setProperty("https.proxyHost", "(the proxy IP address)")
   System.setProperty("https.proxyPort", "(the proxy port)")

   También puede ser útil consultar la TinkerPop documentación sobre la configuración de Grape.

3. En el subdirectorio conf del directorio extraído, cree un archivo llamado neptune-remote.yaml.

   Si usó el AWS CloudFormation plantilla para crear su clúster de base de datos de Neptune, ya existirá un neptune-remote.yaml archivo. En ese caso, todo lo que tiene que hacer es editar el archivo existente para incluir la configuración del canalizador que se muestra a continuación.

   De lo contrario, copie el siguiente texto en el archivo y sustituya (host name) con el nombre de host o la dirección IP de su instancia de base de datos de Neptune. Tenga en cuenta que los corchetes ([]) que rodean el nombre del host son obligatorios.

   hosts: [(host name)]
   port: 8182
   connectionPool: {
     channelizer: org.apache.tinkerpop.gremlin.driver.SigV4WebSocketChannelizer,
     enableSsl: true
   }
   serializer: { className: org.apache.tinkerpop.gremlin.driver.ser.GraphBinaryMessageSerializerV1,
                 config: { serializeResultToString: true }}

4. importante

   Debe proporcionar IAM las credenciales para firmar las solicitudes. Introduzca los siguientes comandos para definir sus credenciales como variables de entorno, sustituyendo los elementos pertinentes por sus credenciales.

   export AWS_ACCESS_KEY_ID=access_key_id
   export AWS_SECRET_ACCESS_KEY=secret_access_key
   export SERVICE_REGION=us-east-1 or us-east-2 or us-west-1 or us-west-2 or ca-central-1 or
                         sa-east-1 or eu-north-1 or eu-west-1 or eu-west-2 or eu-west-3 or eu-central-1 or me-south-1 or
                         me-central-1 or il-central-1 or af-south-1 or ap-east-1 or ap-northeast-1 or ap-northeast-2 or ap-southeast-1 or ap-southeast-2 or ap-south-1 or
                         cn-north-1 or cn-northwest-1 or
                         us-gov-east-1 or us-gov-west-1

   El firmante de Neptune Versión 4 utiliza la cadena predeterminada de proveedores de credenciales. Para ver otros métodos de proporcionar credenciales, consulte Uso de la cadena de proveedores de credenciales predeterminada en la AWS SDK for Java Guía para desarrolladores.

   La variable SERVICE_REGION es obligatoria, incluso cuando se utiliza un archivo de credenciales.

5. Establezca la conexión :remote mediante el archivo .yaml:

   :remote connect tinkerpop.server conf/neptune-remote.yaml

6. Introduzca el siguiente comando para cambiar al modo remoto, que envía todas las consultas de Gremlin a la conexión remota:

   :remote console