Skip to content

Commit f118c89

Browse files
Merge pull request #332 from vishnoianil/update-readme
Updated readme with the tutorial and relevant documentation links
2 parents 4f22481 + f7738c9 commit f118c89

File tree

2 files changed

+26
-20
lines changed

2 files changed

+26
-20
lines changed

README.md

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,11 @@ report a bug, open an [issue](https://github.com/instructlab/ui/issues)! We'd lo
2323
For more, check out the [InstructLab UI Contribution Guide](CONTRIBUTING.md)
2424
and [InstructLab Community Guide](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md).
2525

26-
## Updating the Sealed Secrets
26+
## Tutorials and relevant documentation
2727

28-
To update the sealed secret, you must communicate with the controller that lives in the `kube-system` namespace of the qa cluster.
29-
After signing in to the cluster, you can re-writing the secret file that you want to seal. Then you simply `cat` the secret file,
30-
and pipe that to the `kubeseal` binary as follows:
31-
32-
```bash
33-
cat <secret_file> | kubeseal \
34-
--controller-name=sealed-secrets-controller \
35-
--controller-namespace=kube-system \
36-
--format yaml > <sealed_secret_file>
37-
```
38-
39-
This will generate the new encrypted sealed-secret manifest in the file you specified with `<sealed_secret_file>`. After this please
40-
BE CERTAIN to delete the un-encrypted secret file, we do not want to leak these values in `git`. Finally you can move the `sealed-secret`
41-
to its correct location within this repo.
42-
43-
### Common issues
44-
45-
- `error: cannot get sealed secret service: Unauthorized`: You must be signed in to the qa cluster to be able to communicate with the sealed secrets controller.
28+
- [Skill and Knowledge Contribution Guide](https://docs.instructlab.ai/taxonomy/)
29+
- [UI User Documentation](https://docs.instructlab.ai/user-interface/ui_overview/)
30+
- [Contributing Skills and Knowledge using InstructLab UI](https://developer.ibm.com/tutorials/awb-contributing-llm-granite-instructlab-ui/)
4631

4732
## Community Meeting
4833

docs/development.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,4 +250,25 @@ In our tests since we want to authenticate into the application, there is a shar
250250

251251
The configuration for playwright tests is defined in `playwright.config` file and we're running these tests on Chromium, WebKit and Firefox browsers. Playwright will run all projects by default, but you can use the `--project` command line option to run a single project.
252252

253-
If you'd like to run a specific single test, use the following command with the appropriate folder path to your test. Example: `npx playwright test tests/routing.spec.ts`. To get a detailed report of the completed tests, run `npx playwright show-report` and you'll get a detailed view.
253+
If you'd like to run a specific single test, use the following command with the appropriate folder path to your test. Example: `npx playwright test tests/routing.spec.ts`. To get a detailed report of the completed tests, run `npx playwright show-report` and you'll get a detailed view.
254+
255+
## Updating the Sealed Secrets for the ArgoCD Application
256+
257+
To update the sealed secret, you must communicate with the controller that lives in the `kube-system` namespace of the qa cluster.
258+
After signing in to the cluster, you can re-writing the secret file that you want to seal. Then you simply `cat` the secret file,
259+
and pipe that to the `kubeseal` binary as follows:
260+
261+
```bash
262+
cat <secret_file> | kubeseal \
263+
--controller-name=sealed-secrets-controller \
264+
--controller-namespace=kube-system \
265+
--format yaml > <sealed_secret_file>
266+
```
267+
268+
This will generate the new encrypted sealed-secret manifest in the file you specified with `<sealed_secret_file>`. After this please
269+
BE CERTAIN to delete the un-encrypted secret file, we do not want to leak these values in `git`. Finally you can move the `sealed-secret`
270+
to its correct location within this repo.
271+
272+
### Common issues
273+
274+
- `error: cannot get sealed secret service: Unauthorized`: You must be signed in to the qa cluster to be able to communicate with the sealed secrets controller.

0 commit comments

Comments
 (0)