Create script for Quickstart package

[ionut-arm]

Official Github releases of the service contain a tar gzip file used for quickstart testing. The contents and steps are described in the Quickstart guide. The process of generating the .tar.gz is currently manual, but a script could be included for easier processing in the future.

If we're confident enough, we could even make use of Github Actions to completely automate it.

[anta5010]

parsec-cli-tests.sh can be included into the archive and be mentioned in the Quickstart guide

[mohamedasaker-arm]

@anta5010 I wonder if we can modify the packaged parsec-cli-tests.sh. more precisely this line

PARSEC_SERVICE_ENDPOINT="${PARSEC_SERVICE_ENDPOINT:-unix:/run/parsec/parsec.sock}"

The reason is, that in the release package parsec uses the socket path ./parsec.sock and I think unifying the default socket path would enhance the OOB experience.
Please share your insights

[anta5010]

@anta5010 I wonder if we can modify the packaged parsec-cli-tests.sh. more precisely this line

PARSEC_SERVICE_ENDPOINT="${PARSEC_SERVICE_ENDPOINT:-unix:/run/parsec/parsec.sock}"

The reason is, that in the release package parsec uses the socket path ./parsec.sock and I think unifying the default socket path would enhance the OOB experience. Please share your insights

Sorry, I don't understand what you mean by "the release package parsec uses the socket path ./parsec.sock".

Parsec service built from sources uses /run/parsec/parsec.sock by default. See

parsec/src/front/domain_socket.rs

Line 23 in 87852b7

static DEFAULT_SOCKET_PATH: &str = "/run/parsec/parsec.sock";

And the same parameter value is used by default in the default Parsec config file. See

parsec/config.toml

Line 52 in 87852b7

#socket_path = "/run/parsec/parsec.sock"

So, most likely you're using a Parsec config file where socket_path is set to a non-default value for whatever reason. I think instead of changing parsec-cli-tests.sh you can either:

• fix the config file you're using to use the default value or
• set PARSEC_SERVICE_ENDPOINT env variable to a non-default value you require. For example PARSEC_SERVICE_ENDPOINT='./parsec.sock' parsec-cli-tests.sh

[mohamedasaker-arm]

@anta5010
yes, indeed as it's mentioned here
It is a non-default path
I was just thinking when someone tries to run the script, then he needs to set PARSEC_SERVICE_ENDPOINT.
Do you think we need to add a section after this for the script ?

[ionut-arm]

You have the freedom to alter the parsec-cli-tests.sh script in this quickstart package script, so you can just do a good ol' search-and-replace, and set the path in the script to whatever you need!

[anta5010]

@mohamedasaker-arm I still don't understand your issue. Could you explain it for me.
The script behavior is the same as parset-tool. It uses PARSEC_SERVICE_ENDPOINT if defined or lets parsec-tool to use the default path. I don't see any reason to change the script to a non-default value. The scripts is already used in testings which would be broken. Please use PARSEC_SERVICE_ENDPOINT
I also don't quire understand why do you use a non-default value in your environment. Don't we want to have a quickstart sandbox be as close to real-world deployments as possible?

And please-please do not change the script. I don't want to have two different versions of the same scripts in different repos. It will be a nightmare to support and sync.
You're welcome to add instructions for parsec-cli-tests.sh to the quick guide of course.

[mohamedasaker-arm]

Let's first tackle this question
"Why do you use a non-default value in your environment. Don't we want to have a quickstart sandbox be as close to real-world deployments as possible?"
In order to use the default path without securely installing parsec

• Create or make sure that the /run/parsec path exists
• Change the owner of the folder

sudo mkdir /run/parsec
sudo chown parsec /run/parsec
sudo chmod 755 /run/parsec

The current quickstart package uses a non-default path to avoid those steps @ionut-arm correct me, please!

Regarding this statement "I don't want to have two different versions of the same scripts in different repos. It will be a nightmare to support and sync."
Practically, the edits won't end up in any repo. However, it's a change and might need to be synced If the env variable name has changed.

I don't think the PARSEC_SERVICE_ENDPOINT will change regularly, but indeed this change will require a sync if it happens.

If the script is packaged as it is, then before using the script user has to set the environment variable PARSEC_SERVICE_ENDPOINT.

[anta5010]

By changing the script I didn't mean changing the variable. I meant that when we update the script with some new functionality in parsec-tool repo we will have to remember to apply your change when we copy it from parsec-tool to quickstart

Yes, the last paragraph is correct. If you use a non-default environment you just need to include export PARSEC_SERVICE_ENDPOINT="<your path>" once into your instruction.