Add SageMaker documentation

additionaldocs/README.md

@@ -2,3 +2,4 @@
 
 * [Connections](./connections.md)
 * [Development](./development.md)
+* [SageMaker](./sagemaker)

additionaldocs/sagemaker/README.md

@@ -0,0 +1,11 @@
+## Launching Graph Explorer using Amazon SageMaker
+
+Graph Explorer can be hosted and launched on Amazon SageMaker Notebooks via a lifecycle configuration script. To learn more about lifecycle configurations and how to create one, see the [documentation](https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html).
+
+You can use the sample lifecycle configuration in this folder, [`install-graph-explorer-lc.sh`](install-graph-explorer-lc.sh), or create your own shell script. After you have created the lifecycle configuration, you can apply it to a new or existing SageMaker notebook instance, under `Notebook instance settings` -> `Additional configuration` -> `Lifecycle configuration`.
+
+When the notebook has been started and is in "Ready" state, you can access Graph Explorer by adding the `/proxy/9250/explorer/` extension to the base notebook URL. The Graph Explorer link should look something like:
+
+```
+https://graph-explorer-notebook-name.notebook.us-west-2.sagemaker.aws/proxy/9250/explorer/
+```

additionaldocs/sagemaker/install-graph-explorer-lc.sh

@@ -0,0 +1,75 @@
+#!/bin/bash
+
+sudo -u ec2-user -i <<'EOF'
+
+echo "export GRAPH_NOTEBOOK_AUTH_MODE=DEFAULT" >> ~/.bashrc  # set to IAM instead of DEFAULT if cluster is IAM enabled
+echo "export GRAPH_NOTEBOOK_HOST=CHANGE-ME" >> ~/.bashrc
+echo "export GRAPH_NOTEBOOK_PORT=8182" >> ~/.bashrc
+echo "export AWS_REGION=us-west-2" >> ~/.bashrc  # modify region if needed
+
+EXPLORER_VERSION=""
+for i in "$@"
+do
+case $i in
+    -ev=*|--explorer-version=*)
+    EXPLORER_VERSION="${i#*=}"
+    echo "set explorer version to ${EXPLORER_VERSION}"
+    shift
+    ;;
+esac
+done
+
+source activate JupyterSystemEnv
+source ~/.bashrc || exit
+
+echo "Constructing explorer connection configuration..."
+
+GRAPH_NOTEBOOK_NAME=$(jq '.ResourceName' /opt/ml/metadata/resource-metadata.json --raw-output)
+echo "Grabbed notebook name: ${GRAPH_NOTEBOOK_NAME}"
+
+if [[ ${AWS_REGION} == "cn-north-1" || ${AWS_REGION} == "cn-northwest-1" ]]; then
+  AWS_DOMAIN=com.cn
+else
+  AWS_DOMAIN=aws
+fi
+
+EXPLORER_URI="https://${GRAPH_NOTEBOOK_NAME}.notebook.${AWS_REGION}.sagemaker.${AWS_DOMAIN}/proxy/9250"
+NEPTUNE_URI="https://${GRAPH_NOTEBOOK_HOST}:${GRAPH_NOTEBOOK_PORT}"
+AWS_REGION=${AWS_REGION}
+
+echo "AUTH_MODE from Lifecycle: ${GRAPH_NOTEBOOK_AUTH_MODE}"
+if [[ ${GRAPH_NOTEBOOK_AUTH_MODE} == "IAM" ]]; then
+  IAM=true
+else
+  IAM=false
+fi
+
+echo "Explorer URI: ${EXPLORER_URI}"
+echo "Neptune URI: ${NEPTUNE_URI}"
+echo "Explorer region: ${AWS_REGION}"
+echo "Explorer IAM auth mode: ${IAM}"
+
+echo "Pulling and starting graph-explorer..."
+if [[ ${EXPLORER_VERSION} == "" ]]; then
+  EXPLORER_ECR_TAG=sagemaker-latest
+else
+  EXPLORER_ECR_TAG=sagemaker-${EXPLORER_VERSION}
+fi
+echo "Using explorer image tag: ${EXPLORER_ECR_TAG}"
+
+docker run -d -p 9250:9250 \
+  --env HOST=127.0.0.1 \
+  --env PUBLIC_OR_PROXY_ENDPOINT=${EXPLORER_URI} \
+  --env GRAPH_CONNECTION_URL=${NEPTUNE_URI} \
+  --env USING_PROXY_SERVER=true \
+  --env IAM=${IAM} \
+  --env AWS_REGION=${AWS_REGION} \
+  --env PROXY_SERVER_HTTPS_CONNECTION=false \
+  --env NEPTUNE_NOTEBOOK=true public.ecr.aws/neptune/graph-explorer:${EXPLORER_ECR_TAG}
+
+echo "Explorer installation done."
+
+conda /home/ec2-user/anaconda3/bin/deactivate
+echo "done."
+
+EOF