Getting Started with Sigma IDE on Google Cloud Platform
- a Google Cloud Platform subscription; if you already have a Google account, you can directly sign up.
- a GitHub or BitBucket account; free to sign up if you don't have one already
- a fairly new web browser; Sigma has been tested on Google Chrome 59+, Mozilla Firefox 58+, Microsoft Edge 41+ and Apple Safari 10.1.2+
NOTE: Sigma will soon introduce support for AWS CodeCommit repositories as well!
Create a service account key.
NOTE: This step can be omitted if you already have a saved service account key file for your GCP project.
Open the Cloud Platform dashboard.
If you do not have any GCP projects, create a new project. You can simply follow Google's official guide.
Select your GCP project from the header drop-down.
Open the GCP Service Accounts page. You can use the IAM & admin → Service accounts menu item from within any of the dashboard pages.
Here you will see all service accounts of your project. Even if you have not created any service accounts manually, you will probably have the Google-provisioned default service accounts for App Engine or Compute Engine. These accounts are generally sufficient for Sigma's authorizations.
Alternatively, you can choose or create a different service account that you would like to use to authorize Sigma. The account should possess permissions to:
- Create and write to a new Cloud Storage bucket
- Run builds on CloudBuild (Container Builder) service
- Manage deployments on the Deployment Manager service
- Access other GCP services that you intend to use in your Sigma project
NOTE: If you are using GCP as a secondary platform (e.g. integrating GCP into an AWS-based project) you would only need the last permission.
Refer the Cloud Platform documentation if you want to create a new service account for Sigma.
Click the drop-down at the end of the service account entry, and choose Create key.
Ensure that JSON is selected as the Key type, and click Create.
The private key file will be downloaded into your browser; keep it private and safe.
Enable the required Google Cloud APIs for your GCP project.
If you hope to deploy your project on GCP (as opposed to accessing GCP APIs while running on a different platform like AWS), you would need to enable the following APIs on your GCP project (which are not enabled by default):
- Cloud Functions API
- Cloud Build API
Google Cloud Deployment Manager V2 API
Navigate to the API Library page.
Click Enable APIs and Services on the page header.
Type the name of each API in the search bar.
Click on the search result API tile, and click Enable on the API description page.
- It may take 2-3 minutes for an API to get enabled.
- If you wish to use any other APIs that are not listed in the default enabled APIs list, you will need to explicitly enable them as well - regardless of the deployment platform.
Sign up for Sigma.
Create new Sigma account (if you haven't already):
NOTE: You can avoid most of these steps if you sign in via a social media account (Facebook or Google).
Go to the Sigma sign-in page.
Click the Create an account link against the New to Sigma? message.
Fill in your first and last names, email, and phone number.
Take note of your username: Sigma will automatically generate one, using your first and last names. You are free to change this to your own preference, as long as someone else has not used it already.
Choose a password. Passwords in Sigma need to be at least 8 letters long, and have at least one from each of: uppercase, lowercase, numeric and symbolic (@, $, # etc.) character categories. (For example,
Password#123minimal (but very insecure) example.) You can press and hold the show password button (eye icon) to confirm what you have typed.
When all looks good, click Sign Up. If Sigma succeeds in creating your account, you will be taken to a confirmation page (Insert Confirmation Code). An email will be sent to the address you indicated (from
email@example.com), with a verification code.
Check your email for the verification email (including promotions, spam, trash etc. in case it does not show up in the inbox). Once you find it, copy the 6-digit confirmation code in the email, paste it into the confirmation page, and click Confirm.
If all goes well, you will see the sign-in form with a Confirmation successful! message. Now you can log in using your username (that you took note previously, during sign-up) and password.
Grant GCP access to Sigma.
After sign-in, you'll be in the Cloud Credentials page of Sigma.
Switch to GCP tab, and click the Authorize button.
Copy the full content of the service account key file that you downloaded earlier, and paste it into the text field in the GCP Service Account Key pop-up dialog.
Click Save. The tab view will change with the name of the GCP project of the service account, confirming that your service account key has been successfully interpreted.
If Sigma fails to validate your key, or is unable to access your GCP project using the key, an appropriate error will be displayed; if this happens, please revise the pasted key and its permissions, and try again.
Optionally, switch to the AWS tab and provide an AWS key pair if you wish to also deploy on, or develop against, AWS.
Sigma can save your GCP (and AWS) credentials in its secure AWS Cognito data store. This is solely for your convenience; the content will be encrypted with your own password - also managed by Cognito - or a PIN of your choice, in case you used a social media log-in.
The IDE will automatically load and decrypt the credentials during later log-ins using the password or PIN that you enter, so that you would not need to provide them all over again.
If you prefer not to save the credentials in this manner, turn off the Save to Secure Storage toggle.
Click Load Editor.
NOTE: You can integrate your BitBucket account in pretty much the same way.
Now you will be in the projects page, with a quickstart pane (displaying several Source Provider Integration options) on the left.
Click the Integrate with GitHub button. A GitHub authorization window will pop up (if it does not, tune your browser to enable pop-ups for
sigma.slappforge.comand try again).
On the pop-up, sign in to GitHub if you are not already signed in.
The pop-up will ask you to authorize the Sigma GitHub app (made by
slappforge, the author of Sigma) to connect with your GitHub account. Click the Authorize slappforge button to continue.
Launch a project!
Once GitHub authorization is complete, the pop-up will close, and the quickstart pane will start displaying the already available Sigma projects:
Your Projects tab will display any Sigma-compatible projects that are already in your GitHub account.
Sample Projects tab will display several sample projects published by SLAppForge, which you can try out right away.
If you have the GitHub URL or username of any other Sigma project that you know of, you can simply paste it in the search bar of the Public Search tab and hit the search button, to load it.
Once you have found the desired project, click on it to load it into the Sigma editor.
Alternatively you can create a new project by filling the Create a New Project form on the right side pane:
- Under Project Name, enter a title for your project.
- If you like, add a short description under Project Description, which will be displayed in GitHub etc.
- Select a Base Platform for your project (in this case it would be GCP); this is the serverless platform on which your project will be deployed.
- Enter a version number of the format
x.y.z(compatible with NPM versioning) under Project Version.
- When done, click Create Project.