Follow the deployment walkthrough and get started in no time!
Detailed walkthrough
1. Subscribe screen
After clicking on "View purchase options", click on the "Accept Terms" button and wait a few seconds for the pending period to finish.
Do not configure the annual contract discounted prepay option (total contract price should be $0 as the pricing selection occurs later on when picking the EC2 instance type), and click on the "Continue to Configuration" button.
2. Configure screen
Select a region close to you and click on "Continue to Launch", then on the "Launch" button and finally on the "Next" button.
3. Launch screen
Mandatory configuration:
StackName: Enter the stack name describing this Squey deployment.
KeyName: Select an existing key pair (or create a new one) in order to administer your instance using SSH.
Password: choose a password of 8 characters or more containing at least one element from three
of the following sets: lowercase letters, uppercase letters, base 10 digits,
non-alphanumeric characters.
SSHAllowList: Enter the source CIDR range allowed to administrate your instance using SSH.
Set 0.0.0.0/0 to connect from any address or use x.x.x.x/32 to limit access to a single IP address.
WebAndAPIAllowList: Enter the source CIDR range allowed to access the Squey web application and the Apache Arrow Flight API.
Set 0.0.0.0/0 to connect from any address or use x.x.x.x/32 to limit access to a single IP address.
DiskSize: Select the appropriate disk size (in GB) that suite your needs. This disk will be used to store uploaded datasets as well as Squey ingested data.
AllocateElasticIPAndGenerateSSLCert: Select "Yes" (default) to allocate an Elastic IP address and to have an SSL certificate generated by Let's Encrypt. Select "No" and the instance address IP will change and a self-signed certificate will be generated. Note: under no circumstance Squeylab will have access to any certificate as they will be locally generated on your own instance.
VpcConfiguration: Select 'Default' to use an existing default VPC and public Subnet; select "New" to create a new VPC and public Subnet; select "Custom" to specify an existing public Subnet using the "ExistingSubnetId" parameter.
ExistingSubnetId: Id of an existing Subnet to use, required when "VpcConfiguration" is set to "Custom"
Click on the "Next" button located at the bottom right of the page to go to the "Configure stack options" and then again on the "Next" button located at the bottom right of the "Review and create" page.
Tick the "I acknowledge that AWS CloudFormation might create IAM resources" checkbox and click the "Submit" button to start the deployment.
After 5 to 10 minutes, your secured instance running Squey will be accessible using the "SqueyURL" on the "Outputs" tab (https://<public_ip>.aws.squeylab.com).
Once the EC2 instance is started using the AWS EC2 console or the send-to-squey Python module, Squey is accessible from your browser at the following location: https://<public_ip>.aws.squeylab.com
Connect using username "squey" and the password you chose during deployment and Squey will automatically be launched upon login.
⚠ Please note that on the very first launch after deployment, Squey can take up to one minute to start.
Accessing your data
There are multiple ways to access your data so that you can chose what best suite your needs.
1. Using the DCV file upload web interface
Click the file storage button of the DCV pannel located on the top of the web page and browse or drag and drop your dataset to start to upload to the /srv/data folder of the instance.
You can also use the command line: scp -i ~/.ssh/your_ssh_private_key.pem/path/to/your/dataset squey@https://<public_ip>.aws.squeylab.com:/srv/data
3. Using the S3 bucket automount configuration file
Edit the automount-s3-buckets.conf located on your home folder (accessible from the desktop or from the task bar located on the top of the screen) to specify S3 buckets with the proper permissions.
The S3 buckets will then automatically be monted on the s3-buckets folder of your home directory when saving the configuration file. They will of course persist instance restarts until you remove them from the S3 buckets configuration file.
4. Using the send-to-squey Python module
The send-to-squey Python module is designed to upload and load columnar data structures and Apache Parquet files from your Python code to Squey.
Uploaded datasets are automatically flushed when restarting Squey, unless the dataset is part of a saved investigation.
Mastering Squey
For an exhaustive and in-depth information about open-source software Squey, please consult the reference manual.
FAQ
No, you can change the instance type at will each time the instance is stopped. Be careful nonetheless to select a supported type or you won't be able to start the instance until doing so.
You will be billed hourly for the software and at the second for the EC2 instance. You can stop and restart the instance as often as you need during the same hour and you will only be billed for one hour of software provided you don't change the instance type.
You data are stored on your own AWS infracture and any interaction with the instance is secured using the TLS and SSH protocols. Nor AWS, nor Squeylab have access to your data, your certificates and keys, or any telemetry data.
