Improve documentation about environment variables being used

[pravarag]

What type of PR is this?

/kind documentation

What this PR does / why we need it:

As part of this PR, we are adding documentation for environment variables that are used to configure kube-scheduler-simulator

Which issue(s) this PR fixes:

Fixes #106

Special notes for your reviewer:

/label tide/merge-method-squash

[k8s-ci-robot]

Skipping CI for Draft Pull Request. If you want CI signal for your change, please convert it to an actual PR. You can still manually trigger a test run with /test all

[pravarag]

Thanks for opening the PR. Could you move this doc to README so that users don't miss it?

Sure, do you want me to put the entire contents in README itself or provide a link to this new document in the README file?

[sanposhiho]

provide a link to this new document in the README file?

👍 nice idea. just adding a link to README seems to be fine.

[sanposhiho]

@pravarag Could you add the description about KUBE_SCHEDULER_CONFIG_PATH on docs/env-variables.md as well? https://github.com/kubernetes-sigs/kube-scheduler-simulator/pull/131/files#r857065848

We already have the doc about this here: https://github.com/kubernetes-sigs/kube-scheduler-simulator/blob/master/README.md?plain=1#L32 But, I think it's better to move this to docs/env-variables.md.

[sanposhiho]

And could you rebase and open this PR?

[sanposhiho]

/retitle Improve documentation about environment variables being used

[pravarag]

@sanposhiho I've updated the PR with some new env variables, kindly take a look and let me know for any changes/updates required.

[sanposhiho]

@pravarag Please add link for docs/env-variables.md at somewhere on README.md.

[pravarag]

@pravarag Please add link for docs/env-variables.md at somewhere on README.md.

Done with the latest push.

[196Ikuchil]

Thank you! LGTM about the perspective of the #131 .

ping @sanposhiho

/lgtm

[sanposhiho]

And please add the description about the default value for each variable. And if the environment variable is required one, you may want to add the note about it.

[pravarag]

the description for EXTERNAL_IMPORT_ENABLED is missing

Thanks for a detailed review above. I've added the mentioned variable and also added (required) in front of mandatory variables. Let me know if this looks good or any other changes are required. @sanposhiho @196Ikuchil

[pravarag]

@sanposhiho @196Ikuchil let me know if any further changes are required for this PR :)

[sanposhiho]

Ahhh, sorry, I missed the notification. I will check it this weekend.

[pravarag]

Sorry for too late reviews bow Btw, please feel free to ping me on Kubernetes slack. (I often miss the notification from GitHub because I receive them a lot every day. sweat )

Thanks for the review @sanposhiho , I've updated the code as per the suggested changes :)

[pravarag]

Apologies for the delayed response, I've updated as per review comments @sanposhiho @196Ikuchil .

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pravarag, sanposhiho

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• ~~OWNERS~~ [sanposhiho]

Approvers can indicate their approval by writing /approve in a comment Approvers can cancel approval by writing /approve cancel in a comment

[196Ikuchil]

Thank you for a very very long time! /lgtm