Skip to content
This repository was archived by the owner on Jan 29, 2025. It is now read-only.

Commit 1be23ba

Browse files
uniemimutogashidm
authored andcommitted
Add tips to documentation
This adds a tip for non-root script runners and clarifies the cert selection. Signed-off-by: Ukri Niemimuukko <[email protected]>
1 parent 24f25a3 commit 1be23ba

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

telemetry-aware-scheduling/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ If this pipeline isn't set up, and node level metrics aren't exposed through it,
4646

4747
#### Extender configuration
4848
Note: a shell script that shows these steps can be found [here](deploy/extender-configuration). This script should be seen as a guide only, and will not work on most Kubernetes installations.
49+
<details>
50+
<summary>Instructions for non-root <a href="https://github.com/intel/platform-aware-scheduling/blob/master/telemetry-aware-scheduling/deploy/extender-configuration/configure-scheduler.sh">configure-scheduler.sh</a> script runners</summary>
51+
52+
>The `configure-scheduler.sh` script needs write access to under `/etc`. One typically either runs it as root, or you have to use sudo.
53+
It also requires that sudo (or root) needs to have a working kubectl access to the cluster. If running `sudo kubectl version` looks ok,
54+
you are likely good to go. If that produced an error, consider giving the folder `/root/.kube/` the cluster config file.
55+
</details>&nbsp;
4956

5057
The extender configuration files can be found under deploy/extender-configuration.
5158
TAS Scheduler Extender needs to be registered with the Kubernetes Scheduler. In order to do this a configuration file should be created like one the below:
@@ -93,6 +100,13 @@ The secret can be created with:
93100
``
94101
kubectl create secret tls extender-secret --cert /etc/kubernetes/<PATH_TO_CERT> --key /etc/kubernetes/<PATH_TO_KEY>
95102
``
103+
<details>
104+
<summary>Cert selection tip for <a href="https://github.com/intel/platform-aware-scheduling/blob/24f25a38613e326b4830f5e647211df16060fe70/telemetry-aware-scheduling/deploy/extender-configuration/configure-scheduler.sh#L136-L137">configure-scheduler.sh</a> users</summary>
105+
106+
>The `configure-scheduler.sh` script is hard-coded to use `/etc/kubernetes/pki/ca.key` and `/etc/kubernetes/pki/ca.crt`. The cert for the secret
107+
must match the scheduler configuration, so use those files. If you instead want to use your own cert, you need to configure the scheduler to match.
108+
</details>&nbsp;
109+
96110
In order to deploy run:
97111

98112
``kubectl apply -f deploy/``

0 commit comments

Comments
 (0)