Skip to content

Commit 8db3b98

Browse files
authored
Merge pull request #7 from carlosrodlop/docs
Docs Improvements
2 parents 7529fa0 + 7ff938c commit 8db3b98

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,17 @@
1212
| [Documentation](https://github.com/carlosrodlop/carlosrodlop-docs/tree/main/kubernetes) | [References](https://github.com/carlosrodlop/carlosrodlop-docs#kubernetes) |
1313
| --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
1414

15-
- It contains charts and roots deployments for different Applications and Kubernetes add-ons
16-
- Command and Processes are orchestrated via `Makefile`. It is tested to be used with asdf images from [Docker Library](https://github.com/carlosrodlop/docker-lib) making its content portable.
17-
- It has been developed using tools provided in [asdf.ubuntu](https://github.com/carlosrodlop/docker-lib/tree/v1.1.0/docker/asdf.ubuntu) image for testing.
15+
## About
16+
17+
- It is a collection of resources to operate with Kubernetes including:
18+
- Application Definition: Manifests and Templates (Helm charts)
19+
- Scripts
20+
- Makefiles to orchestrate commands and processes
21+
- Note: Services and Namespaces names are not configurable to avoid break integrations.
22+
23+
## Development
24+
25+
- It is Developed using Containers from the [Docker Library](https://github.com/carlosrodlop/docker-lib): `swissknife.ubuntu` and `swissknife.alpine`
1826
- It uses submodules. For example, Helm chart `cb-ci-local` uses Casc Bundles from [carlosrodlop/cb-casc-controllers](https://github.com/carlosrodlop/cb-casc-controllers/tree/main) and [carlosrodlop/cb-casc-oc](https://github.com/carlosrodlop/cb-casc-oc/tree/main).
1927
- ⚠️ IMPORTANT - It requires `git submodule update --init --recursive`
20-
- It uses [Pre-commits](.pre-commit-config.yaml) for Validations and Documentation
21-
- Note: Services and Namespaces names are not configurable to avoid break integrations.
28+
- It uses [Pre-commits](.pre-commit-config.yaml). See [quickstart](https://pre-commit.com/#quick-start)

make/cbcd/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# CloudBees CD
22

3-
Steps to check successfull installation
3+
## Known issues
4+
5+
Flow-server pod is entering into `CrashLoopBackOff` state due
6+
7+
```bash
8+
Could not start amazon-efs-mount-watchdog, unrecognized init system "aws-efs-csi-dri" b'mount.nfs4: access denied by server while mounting 127.0.0.1:/
9+
```
10+
11+
## Steps to check successful installation
412
513
- Helm output
614

0 commit comments

Comments
 (0)