Skip to content

Commit 117599a

Browse files
vdaviotvdaviot
committed
documentation: add basic AI generated doc
Signed-off-by: Valentin Daviot <valentin.daviot@scality.com>
1 parent 0d1a712 commit 117599a

4 files changed

Lines changed: 647 additions & 0 deletions

File tree

‎CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Global owners
2+
* @scality/metalk8s

‎CONTRIBUTING.md‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
# Contributing to disk-management-agent
2+
3+
Thank you for your interest in contributing. This document explains the
4+
development workflow, coding standards, and process for submitting changes.
5+
6+
## Code of Conduct
7+
8+
All participants are expected to treat each other with respect and
9+
professionalism. Harassment, discrimination, and disruptive behavior will not be
10+
tolerated. Be constructive in code reviews and discussions.
11+
12+
## Development Workflow
13+
14+
1. Fork the repository and clone your fork.
15+
2. Create a feature branch from `main`:
16+
```bash
17+
git checkout -b feature/my-change
18+
```
19+
3. Make your changes, ensuring they follow the coding standards below.
20+
4. Run the full validation suite before pushing:
21+
```bash
22+
make manifests generate fmt vet lint test
23+
```
24+
5. Push your branch and open a pull request against `main`.
25+
26+
## Prerequisites
27+
28+
| Tool | Version | Purpose |
29+
|---|---|---|
30+
| Go | 1.25+ | Build and test |
31+
| Make | any | Build system |
32+
| Docker | any | Container image builds |
33+
| Kind | any | End-to-end tests |
34+
| kubectl | any | Cluster interaction |
35+
36+
All other tools (`controller-gen`, `kustomize`, `setup-envtest`, `golangci-lint`)
37+
are downloaded automatically by the Makefile into `./bin/`.
38+
39+
## Setting Up the Development Environment
40+
41+
```bash
42+
# Clone and enter the repository
43+
git clone https://github.com/scality/disk-management-agent.git
44+
cd disk-management-agent
45+
46+
# Download Go dependencies
47+
go mod download
48+
49+
# Generate manifests, deepcopy, format, and vet
50+
make manifests generate fmt vet
51+
52+
# Run unit tests to confirm everything works
53+
make test
54+
```
55+
56+
## Coding Standards
57+
58+
### Clean Architecture
59+
60+
The project follows clean architecture under `pkg/`:
61+
62+
- **`pkg/domain/`** -- Core business entities. No external dependencies.
63+
- **`pkg/service/`** -- Interface definitions (ports). Use cases depend on these.
64+
- **`pkg/usecase/`** -- Application business logic. Must not import
65+
infrastructure packages.
66+
- **`pkg/infrastructure/`** -- Adapters that implement service interfaces.
67+
68+
Dependency direction is always **inward**: infrastructure depends on use cases
69+
and service interfaces, never the reverse.
70+
71+
### Interface Naming
72+
73+
Interfaces follow the `<Entity><Action>er` pattern:
74+
75+
```go
76+
type PhysicalDriveDiscoverer interface { ... }
77+
type DiscoveredDriveCacheReader interface { ... }
78+
```
79+
80+
Composite interfaces (repositories, services) may use broader names but must
81+
embed small, focused interfaces.
82+
83+
### Error Handling
84+
85+
Wrap all errors with context using `errors.Wrap` or `fmt.Errorf` with `%w`:
86+
87+
```go
88+
return errors.Wrap(err, fmt.Sprintf("disk %s not accessible", diskID))
89+
```
90+
91+
Include relevant identifiers. Avoid duplicating context already present in the
92+
error chain.
93+
94+
### Interface Size
95+
96+
Interfaces are limited to 1-2 methods. Only composite interfaces may have more
97+
through embedding.
98+
99+
### Linting
100+
101+
The project uses [golangci-lint](https://golangci-lint.run/) with the
102+
configuration in `.golangci.yml`. Run it locally before pushing:
103+
104+
```bash
105+
make lint
106+
```
107+
108+
## Testing
109+
110+
### Unit Tests
111+
112+
Unit tests and controller tests (using envtest) run together:
113+
114+
```bash
115+
make test
116+
```
117+
118+
Coverage output is written to `cover.out`.
119+
120+
### End-to-End Tests
121+
122+
E2E tests require a Kind cluster. The Makefile manages the cluster lifecycle:
123+
124+
```bash
125+
make test-e2e
126+
```
127+
128+
This creates a Kind cluster named `disk-management-agent-test-e2e`, runs the
129+
tests, and tears it down automatically.
130+
131+
### Writing Tests
132+
133+
- Controller tests use the
134+
[envtest](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/envtest)
135+
framework and Ginkgo/Gomega.
136+
- Use case tests use [testify](https://github.com/stretchr/testify) with mock
137+
implementations of service interfaces.
138+
- Test files live alongside the code they test (`_test.go` suffix).
139+
140+
## Pull Request Process
141+
142+
1. Ensure all CI checks pass (lint + tests).
143+
2. Keep PRs focused: one logical change per PR.
144+
3. Write a clear PR description explaining **what** changed and **why**.
145+
4. At least one approval from a code owner is required before merging.
146+
5. Squash-merge is preferred for a clean commit history.
147+
148+
### Branch Naming
149+
150+
Use descriptive prefixes:
151+
152+
- `feature/` -- New functionality
153+
- `fix/` -- Bug fixes
154+
- `improvement/` -- Refactoring or enhancements
155+
- `docs/` -- Documentation changes
156+
157+
## Issue Reporting
158+
159+
### Bug Reports
160+
161+
When reporting a bug, include:
162+
163+
- Steps to reproduce
164+
- Expected behavior
165+
- Actual behavior
166+
- Environment details (Go version, Kubernetes version, RAID controller type)
167+
- Relevant logs or error messages
168+
169+
### Feature Requests
170+
171+
Describe the use case, the expected behavior, and why the existing functionality
172+
does not cover it.
173+
174+
## Documentation
175+
176+
When making code changes, update relevant documentation:
177+
178+
- If you add or modify CRD fields, regenerate manifests with `make manifests`.
179+
- If you add environment variables, update the configuration table in
180+
`README.md`.
181+
- If you change architecture or add components, update the architecture diagram
182+
in `README.md`.
183+
184+
## License
185+
186+
By contributing to this project, you agree that your contributions will be
187+
licensed under the [Apache License 2.0](LICENSE).

‎LICENSE‎

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to the Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by the Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding any notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. Please also get an approval
185+
for the project name and scheme from your group.
186+
187+
Copyright [yyyy] [name of copyright owner]
188+
189+
Licensed under the Apache License, Version 2.0 (the "License");
190+
you may not use this file except in compliance with the License.
191+
You may obtain a copy of the License at
192+
193+
http://www.apache.org/licenses/LICENSE-2.0
194+
195+
Unless required by applicable law or agreed to in writing, software
196+
distributed under the License is distributed on an "AS IS" BASIS,
197+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
198+
implied. See the License for the specific language governing
199+
permissions and limitations under the License.

0 commit comments

Comments
 (0)