Allow `scwToken` to be declared out from the `serverless.yaml`

[GerkinDev]

Hi,

I'm using the serverless framework along with this plugin to manage my FaaS. I'm also using the scaleway-cli.

I think the serverless.yaml file should be commited in my git repository, but I won't commit a secret token.

I've seen that page: https://www.serverless.com/framework/docs/providers/aws/cli-reference/config-credentials , but I don't know exactly what is supposed to be the key or the secret.

Would it be possible to load the secret key from another file, an env var, or even the scaleway-cli config ?

Cheers

[thomas-tacquet]

Hello,

I advise you to use environment variables since it's an easy way to manage an to keep out of unwanted git commit 😁

You can use SCW_SECRET_KEY for your secret token and SCW_DEFAULT_PROJECT_ID for your project_id.

You can find out code that manage these variables here : https://github.com/scaleway/serverless-scaleway-functions/blob/master/provider/scalewayProvider.js#L49

Let us know if the solution is ok for you.

[GerkinDev]

Great ! I didn't took the time to look at the source code, and the documentation isn't clear enough (or I just didn't found the info).

Could it be done by retrieving the scaleway CLI config ?

[GerkinDev]

Or even implement what is required to work with serverless built-in token storage https://www.serverless.com/framework/docs/providers/aws/cli-reference/config-credentials

[thomas-tacquet]

About de CLI config it's the same variable names, it should work but I haven't tried yet : https://github.com/scaleway/scaleway-cli/blob/master/docs/commands/config.md

For the built-in token management for serverless framework I'm going to look at 👌

[stackapaul]

Personally, I prefer to create a .env file at the root of my project where I store all my secret keys. To work with this configuration, set useDotenv: true at the beginning of the serverless.yml file and you can call your environment variables in the yaml like this : scwToken: ${env:SLS_SCALEWAY_TOKEN}.

Here is my serverless.yml file :

service: scaleway-python3
configValidationMode: off
frameworkVersion: '3'

useDotenv: true

provider:
  name: scaleway
  runtime: python38
  # Global Environment variables - used in every functions
  env:
    test: test
  scwToken: ${env:SLS_SCALEWAY_TOKEN}
  scwProject: ${env:SCALEWAY_PROJECT}
  # region in which the deployment will happen, (default fr-par)
  scwRegion: ${env:SCALEWAY_REGION}

plugins:
  - serverless-scaleway-functions

package:
  patterns:
    - '!node_modules/**'
    - '!.gitignore'
    - '!.git/**'

functions:
  first:
    handler: handler.handle
    # Local environment variables - used only in given function
    env:
      local: local

And my .env file is something like this :

SCALEWAY_PROJECT=*********
SCALEWAY_REGION=fr-par
SLS_SCALEWAY_TOKEN=*********

Here is the doc of useDotenv in serverless framework : https://www.serverless.com/framework/docs/environment-variables

[thomas-tacquet]

Thank you both for the questions/answers I'll update the documentation help future users 👌

[GerkinDev]

Yeah please. Recommending to put secrets in a config file that should AFAICT be committed in VCS seems super insecure, and IMO not even mentioned in a quickstart guide. Indeed, answers provide great workarounds.

[thomas-tacquet]

@GerkinDev @stackapaul here is my PR : #78 feel free to review it if I missed something 👍

[GerkinDev]

Great, thanks!