Skip to content

Commit e6d3922

Browse files
authored
chore: added missing link to further details (#1150)
1 parent a93865e commit e6d3922

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# KubeOps - Kubernetes Operators in .NET
1+
# KubeOps Kubernetes Operators in .NET
22

33
**Build Kubernetes Operators in .NET with Ease**
44

@@ -16,7 +16,7 @@ The documentation is also provided within the code itself (description of method
1616

1717
- **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.
1818
- **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>`.
2020
- **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.
2121
- **Code Generation:** Includes Roslyn source generators and a CLI tool (`kubeops`) to automate boilerplate code for CRDs, controllers, and RBAC rules.
2222
- **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
102102
aspire publish --project src/MyApp.AppHost/MyApp.AppHost.csproj --output-path ./artifacts/k8s
103103
```
104104

105+
For further details, see the [Aspire documentation](https://dotnet.github.io/dotnet-operator-sdk/docs/operator/aspire).
105106

106107
## Packages
107108

@@ -110,10 +111,10 @@ The runtime libraries target [.NET 8.0](https://learn.microsoft.com/en-us/dotnet
110111
The SDK is designed to be modular. You can include only the packages you need:
111112

112113
| Package | Description |
113-
| -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
114+
|----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
114115
| [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. |
117118
| [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. |
118119
| [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. |
119120
| [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 [
128129
129130
## License
130131
131-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. This license applies to all packages in the KubeOps SDK.
132+
This project is licensed under the Apache License 2.0 see the [LICENSE](LICENSE) file for details. This license applies to all packages in the KubeOps SDK.
132133
133134
## .NET Foundation
134135
@@ -142,7 +143,7 @@ KubeOps is maintained by the repository collaborators and maintainers. We welcom
142143
143144
If you want to contribute, feel free to open a pull request or write issues :-)
144145
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.
146147
147148
Read more about contribution (especially for setting up your local environment)
148149
in the [CONTRIBUTING file](./CONTRIBUTING.md).

0 commit comments

Comments
 (0)