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
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# KubeOps - Kubernetes Operators in .NET
1
+
# KubeOps – Kubernetes Operators in .NET
2
2
3
3
**Build Kubernetes Operators in .NET with Ease**
4
4
@@ -16,7 +16,7 @@ The documentation is also provided within the code itself (description of method
16
16
17
17
-**Define CRDs in C#:** Model your [Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/) using plain C# classes and attributes.
18
18
-**Controller Logic:** Implement reconciliation logic using the `IEntityController<TEntity>` interface.
19
-
-**Finalizers:**Easily add cleanup logic before resource deletion with `IEntityFinalizer<TEntity>`.
19
+
-**Finalizers:**Add cleanup logic before resource deletion with `IEntityFinalizer<TEntity>`.
20
20
-**Webhooks:** Create [Admission](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/) (validating/mutating) and [Conversion](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#webhook-conversion) webhooks integrated with ASP.NET Core.
21
21
-**Code Generation:** Includes Roslyn source generators and a CLI tool (`kubeops`) to automate boilerplate code for CRDs, controllers, and RBAC rules.
22
22
-**Enhanced Kubernetes Client:** Provides convenience methods built on top of the official client library.
@@ -102,6 +102,7 @@ aspire run --project src/MyApp.AppHost/MyApp.AppHost.csproj
| [KubeOps.Abstractions](./src/KubeOps.Abstractions/README.md) | Defines core interfaces, attributes (like `[KubernetesEntity]`), and base classes used across the SDK. Essential for defining your custom resources and controllers. |
115
-
| [KubeOps.Aspire](./src/KubeOps.Aspire/README.md) | [.NET Aspire](https://learn.microsoft.com/dotnet/aspire/) service defaults for an operator: a single `AddKubeOpsServiceDefaults()` call wiring up OpenTelemetry, service discovery, HTTP resilience, and health checks. |
116
-
| [KubeOps.Aspire.Hosting](./src/KubeOps.Aspire.Hosting/README.md) | [.NET Aspire](https://learn.microsoft.com/dotnet/aspire/) hosting integration. Adds `AddKubeOps<TProject>(...)` so a KubeOps operator can be orchestrated as a resource inside an Aspire AppHost. |
116
+
| [KubeOps.Aspire](./src/KubeOps.Aspire/README.md) | [.NET Aspire](https://learn.microsoft.com/dotnet/aspire/) service defaults for an operator: a single `AddKubeOpsServiceDefaults()` call wiring up OpenTelemetry, service discovery, HTTP resilience, and health checks. |
117
+
| [KubeOps.Aspire.Hosting](./src/KubeOps.Aspire.Hosting/README.md) | [.NET Aspire](https://learn.microsoft.com/dotnet/aspire/) hosting integration. Adds `AddKubeOps<TProject>(...)` so a KubeOps operator can be orchestrated as a resource inside an Aspire AppHost. |
117
118
| [KubeOps.Cli](./src/KubeOps.Cli/README.md) | A [.NET Tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools) providing commands for scaffolding projects, generating [Custom Resource Definitions (CRDs)](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/), and more. |
118
119
| [KubeOps.Generator](./src/KubeOps.Generator/README.md) | Contains [Roslyn Source Generators](https://docs.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview) to automate boilerplate code generation for CRDs and controllers based on your definitions. |
119
120
| [KubeOps.KubernetesClient](./src/KubeOps.KubernetesClient/README.md) | Provides an enhanced client for interacting with the [Kubernetes API](https://kubernetes.io/docs/reference/kubernetes-api/), built on top of the official `KubernetesClient` library. Offers convenience methods for common operator tasks. |
@@ -128,7 +129,7 @@ You can find various example operators demonstrating different features in the [
128
129
129
130
## License
130
131
131
-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file fordetails. This license applies to all packagesin the KubeOps SDK.
132
+
This project is licensed under the Apache License 2.0 – see the [LICENSE](LICENSE) file fordetails. This license applies to all packagesin the KubeOps SDK.
132
133
133
134
## .NET Foundation
134
135
@@ -142,7 +143,7 @@ KubeOps is maintained by the repository collaborators and maintainers. We welcom
142
143
143
144
If you want to contribute, feel free to open a pull request or write issues :-)
144
145
Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md).
145
-
By participating in this project you agree to abide by its terms.
146
+
By participating in this project, you agree to abide by its terms.
146
147
147
148
Read more about contribution (especially for setting up your local environment)
0 commit comments