You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 13, 2025. It is now read-only.
Microcks project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
4
+
5
+
## Our Pledge
6
+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
7
+
8
+
## Enforcement
9
+
10
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team via [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
We love your input! We want to make contributing to this project as easy and transparent as possible.
4
+
5
+
## Contribution recogniton
6
+
7
+
We plan to use [All Contributors](https://allcontributors.org/docs/en/specification) specification to handle recognitions.
8
+
9
+
## Summary of the contribution flow
10
+
11
+
The following is a summary of the ideal contribution flow. Please, note that Pull Requests can also be rejected by the maintainers when appropriate.
12
+
13
+
```
14
+
┌───────────────────────┐
15
+
│ │
16
+
│ Open an issue │
17
+
│ (a bug report or a │
18
+
│ feature request) │
19
+
│ │
20
+
└───────────────────────┘
21
+
⇩
22
+
┌───────────────────────┐
23
+
│ │
24
+
│ Open a Pull Request │
25
+
│ (only after issue │
26
+
│ is approved) │
27
+
│ │
28
+
└───────────────────────┘
29
+
⇩
30
+
┌───────────────────────┐
31
+
│ │
32
+
│ Your changes will │
33
+
│ be merged and │
34
+
│ published on the next │
35
+
│ release │
36
+
│ │
37
+
└───────────────────────┘
38
+
```
39
+
40
+
## Code of Conduct
41
+
42
+
Microcks has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](CODE_OF_CONDUCT.md) so that you can understand what sort of behaviour is expected.
43
+
44
+
## Our Development Process
45
+
46
+
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
47
+
48
+
## Issues
49
+
50
+
[Open an issue](https://github.com/microcks/microcks/issues/new)**only** if you want to report a bug or a feature. Don't open issues for questions or support, instead join our [Zulip #user channel](https://microcksio.zulipchat.com/) or our [GitHub discussions](https://github.com/orgs/microcks/discussions) and ask there.
51
+
52
+
## Bug Reports and Feature Requests
53
+
54
+
Please use our issues templates that provide you with hints on what information we need from you to help you out.
55
+
56
+
## Pull Requests
57
+
58
+
**Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or a really obvious error.** Pull requests are the best way to propose changes to the specification. Take time to check the current working branch for the repository you want to contribute on before working :wink:
59
+
60
+
## Conventional commits
61
+
62
+
Our repositories follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
63
+
64
+
Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification simply ask maintainers to modify. You can also use this cheatsheet if you want:
65
+
66
+
-`fix: ` prefix in the title indicates that PR is a bug fix and PATCH release must be triggered.
67
+
-`feat: ` prefix in the title indicates that PR is a feature and MINOR release must be triggered.
68
+
-`docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release.
69
+
-`chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release.
70
+
-`test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release.
71
+
-`refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release.
72
+
73
+
What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: `
74
+
75
+
Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).
76
+
77
+
Happy contributing :heart:
78
+
79
+
## License
80
+
81
+
When you submit changes, your submissions are understood to be under the same [Apache 2.0 License](https://github.com/microcks/microcks/blob/master/LICENSE) that covers the project. Feel free to [contact the maintainers](https://microcksio.zulipchat.com/) if that's a concern.
82
+
83
+
## References
84
+
85
+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md).
@@ -183,7 +184,7 @@ The table below describe all the fields of the `MicrocksInstall` CRD, providing
183
184
| `keycloak` | `storageClassName` | **Optional**. The cluster storage class to use for persistent volume claim. If not specified, we rely on cluster default storage class. |
184
185
| `keycloak` | `postgresImage` | **Optional**. The reference of container image used. Operator comes with its default version. |
185
186
| `keycloak` | `url` | **Mandatory on Kube if keycloak.install==false, Optional otherwise**. The URL of Keycloak install - indeed just the hostname + port part - if it already exists on the one used for exposing Keycloak `Ingress`. If missing on OpenShift, default URL schema handled by Router is used. |
186
-
| `keycloak` | `privateUrl` | **Optional**. A private URL - a full URL here - used by the Microcks component to internally join Keycloak. This is also known as `backendUrl` in [Keycloak doc](https://www.keycloak.org/docs/latest/server_installation/#_hostname). When specified, the `keycloak.url` is used as `frontendUrl` in Keycloak terms. |
187
+
| `keycloak` | `privateUrl` | **Optional but recommended**. A private URL - a full URL here - used by the Microcks component to internally join Keycloak. This is also known as `backendUrl` in [Keycloak doc](https://www.keycloak.org/docs/latest/server_installation/#_hostname). When specified, the `keycloak.url` is used as `frontendUrl` in Keycloak terms. |
187
188
| `keycloak` | `ingressSecretRef` | **Optional on Kube, not used on OpenShift**. The name of a TLS Secret for securing `Ingress`. If missing on Kubernetes, self-signed certificate is generated. |
188
189
| `keycloak` | `ingressAnnotations` | **Optional**. Some custom annotations to add on `Ingress` or OpenShift `Route`. If these annotations are triggering a Certificate generation (for example through https://cert-manager.io/ or https://github.com/redhat-cop/cert-utils-operator), the `generateCert` property should be set to `false` on Kube. |
189
190
| `keycloak` | `generateCert` | **Optional on Kube, not used on OpenShift**. Whether to generate self-signed certificate or not if no valid `ingressSecretRef` provided. Default is `true` |
0 commit comments