documentation

nforgeio · Feb 6, 2024 · f6d8174 · f6d8174
1 parent 87d5e25
commit f6d8174
Show file tree

Hide file tree

Showing 21 changed files with 164 additions and 41 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -78,9 +78,6 @@
         <DefineConstants>$(DefineConstants);JUSTMOCK</DefineConstants>
     </PropertyGroup>
 
-    <ItemGroup Condition="Exists('README.md')">
-        <None Include="README.md" Pack="true" PackagePath="" />
-    </ItemGroup>
 
     <!-- $hack(jefflill):
     

diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # Neon.Operator: Potentially useful libraries published as NuGet packages
 
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Operator?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Operator)
+
 [![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
 
 ---

diff --git a/...netes.Resources/Istio/V1GatewayGateway.cs → ...n.Kubernetes.Resources/Istio/V1Gateway.cs b/...netes.Resources/Istio/V1GatewayGateway.cs → ...n.Kubernetes.Resources/Istio/V1Gateway.cs
diff --git a/src/Neon.Kubernetes.Resources/Neon.Kubernetes.Resources.csproj b/src/Neon.Kubernetes.Resources/Neon.Kubernetes.Resources.csproj
@@ -15,6 +15,7 @@
         <PackageTags>kubernetes operator sdk neonkube k8s</PackageTags>
         <PackageReleaseNotes>https://github.com/nforgeio/operator-sdk/releases</PackageReleaseNotes>
         <DebugType>full</DebugType>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <!-- NEONFORGE package or project references -->
@@ -48,6 +49,7 @@
     <ItemGroup>
         <None Include="..\nuget-icon.png" Pack="true" PackagePath="" />
         <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
+        <None Include="README.md" Pack="true" PackagePath="" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Neon.Kubernetes.Resources/README.md b/src/Neon.Kubernetes.Resources/README.md
@@ -0,0 +1,34 @@
+# Neon.Kubernetes.Resources
+
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Kubernetes.Resources?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Kubernetes.Resources)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
+
+---
+
+Contains some useful custom resource definitions (CRDs) and other resources for working with Kubernetes.
+
+## CRD types
+
+Cert Manager:
+- `V1Certificate`
+- `V1CertificateRequest`
+- `V1ClusterIssuer`
+
+Grafana:
+- `V1GrafanaDashboard`
+- `V1GrafanaDatasource`
+
+Istio:
+- `V1AuthorizationPolicy`
+- `V1DestinationRule`
+- `V1Gateway`
+- `V1ServiceEntry`
+- `V1Telemetry`
+- `V1VirtualService`
+
+Prometheus:
+- `V1ServiceMonitor`
+
+Neon.Kubernetes.Resources is an open source project released under the Apache-2.0 license.
diff --git a/src/Neon.Kubernetes/Neon.Kubernetes.csproj b/src/Neon.Kubernetes/Neon.Kubernetes.csproj
@@ -14,6 +14,7 @@
         <RepositoryType>git</RepositoryType>
         <PackageTags>kubernetes operator sdk neonkube k8s</PackageTags>
         <PackageReleaseNotes>https://github.com/nforgeio/operator-sdk/releases</PackageReleaseNotes>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
@@ -44,6 +45,7 @@
     <ItemGroup>
         <None Include="..\nuget-icon.png" Pack="true" PackagePath="" />
         <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
+        <None Include="README.md" Pack="true" PackagePath="" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/src/Neon.Kubernetes/README.md b/src/Neon.Kubernetes/README.md
@@ -0,0 +1,12 @@
+# Neon.Kubernetes
+
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Kubernetes?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Kubernetes)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
+
+---
+
+Contains some useful extensions and utilities for working with Kubernetes.
+
+Neon.Kubernetes is an open source project released under the Apache-2.0 license.
diff --git a/src/Neon.Operator.Analyzers/Neon.Operator.Analyzers.csproj b/src/Neon.Operator.Analyzers/Neon.Operator.Analyzers.csproj
@@ -19,6 +19,7 @@
         <IsRoslynComponent>true</IsRoslynComponent>
         <EnforceExtendedAnalyzerRules>false</EnforceExtendedAnalyzerRules>
         <NoWarn>$(NoWarn);CS1591;CS8034</NoWarn>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
@@ -111,6 +112,7 @@
         <None Include="..\nuget-icon.png" Pack="true" PackagePath="" />
         <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
         <None Include="build\*" Pack="true" PackagePath="build\" />
+        <None Include="README.md" Pack="true" PackagePath="" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Neon.Operator.Analyzers/README.md b/src/Neon.Operator.Analyzers/README.md
@@ -0,0 +1,15 @@
+# Neon.Operator.Analyzers: Potentially useful libraries published as NuGet packages
+
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Operator.Analyzers?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Operator.Analyzers)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
+
+---
+
+A set of Roslyn analyzers for working with Neon.Operator. This package is included as a dependency in the Neon.Operator package.
+
+## Documentation:
+- [Docs](https://docs.neonforge.com/docs/operator-sdk)
+
+Neon.Operator.Analyzers is an open source project released under the Apache-2.0 license.
diff --git a/src/Neon.Operator.Core/Neon.Operator.Core.csproj b/src/Neon.Operator.Core/Neon.Operator.Core.csproj
@@ -14,6 +14,7 @@
         <RepositoryType>git</RepositoryType>
         <PackageTags>kubernetes operator sdk neonkube k8s</PackageTags>
         <PackageReleaseNotes>https://github.com/nforgeio/operator-sdk/releases</PackageReleaseNotes>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
@@ -44,6 +45,7 @@
     <ItemGroup>
         <None Include="..\nuget-icon.png" Pack="true" PackagePath="" />
         <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
+        <None Include="README.md" Pack="true" PackagePath="" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Neon.Operator.Core/README.md b/src/Neon.Operator.Core/README.md
@@ -0,0 +1,15 @@
+# Neon.Operator.Core: Potentially useful libraries published as NuGet packages
+
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Operator.Core?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Operator.Core)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
+
+---
+
+This package contains the core functionality for building Kubernetes operators in .NET. It is included as a dependency in the Neon.Operator package.
+
+## Documentation:
+- [Docs](https://docs.neonforge.com/docs/operator-sdk)
+
+Neon.Operator.Core is an open source project released under the Apache-2.0 license.
diff --git a/src/Neon.Operator.Templates/Neon.Operator.Templates.csproj b/src/Neon.Operator.Templates/Neon.Operator.Templates.csproj
@@ -18,6 +18,7 @@
         <IncludeBuildOutput>false</IncludeBuildOutput>
         <ContentTargetFolders>content</ContentTargetFolders>
         <NoWarn>$(NoWarn);1591;CS2008</NoWarn>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
@@ -36,6 +37,7 @@
     <ItemGroup>
         <None Include="..\nuget-icon.png" Pack="true" PackagePath="" />
         <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
+        <None Include="README.md" Pack="true" PackagePath="" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Neon.Operator.Templates/OperatorTemplate/.template.config/template.json b/src/Neon.Operator.Templates/OperatorTemplate/.template.config/template.json
@@ -4,31 +4,14 @@
   "classifications": [ "Kubernetes Operator" ],
   "name": "Kubernetes Operator",
   "description": "Kubernetes operator",
-  "identity": "Neon.Kube.Operator.Templates.Csharp",
-  "groupIdentity": "Neon.Kube.Operator.Templates",
-  "shortName": "k8s operator",
+  "identity": "Neon.Operator.Templates.Csharp",
+  "groupIdentity": "Neon.Operator.Templates",
+  "shortName": "k8s-operator",
   "tags": {
     "language": "C#",
     "type": "project"
   },
   "sourceName": "OperatorTemplate",
   "defaultName": "Kubernetes Operator",
-  "preferNameDirectory": true,
-  "postActions": [
-    {
-      "description": "Adding Reference to Neon.Kube.Operator NuGet package",
-      "actionId": "B17581D1-C5C9-4489-8F0A-004BE667B814",
-      "continueOnError": false,
-      "manualInstructions": [
-        {
-          "text": "Manually add the reference to Neon.Kube.Operator to your project file"
-        }
-      ],
-      "args": {
-        "referenceType": "package",
-        "reference": "Neon.Kube.Operator",
-        "projectFileExtensions": ".csproj"
-      }
-    }
-  ]
+  "preferNameDirectory": true
 }
diff --git a/src/Neon.Operator.Templates/OperatorTemplate/Controllers/ExampleController.cs b/src/Neon.Operator.Templates/OperatorTemplate/Controllers/ExampleController.cs
@@ -1,17 +1,14 @@
-using System;
-using System.Collections.Generic;
 using System.Threading.Tasks;
 
+using k8s;
+using k8s.Models;
+
 using Microsoft.Extensions.Logging;
 
 using Neon.Operator.Controllers;
 using Neon.Operator.Finalizers;
-using Neon.Operator.ResourceManager;
 using Neon.Tasks;
 
-using k8s;
-using k8s.Models;
-
 namespace OperatorTemplate
 {
     public class ExampleController : ResourceControllerBase<V1ExampleEntity>

diff --git a/src/Neon.Operator.Templates/OperatorTemplate/Finalizers/ExampleFinalizer.cs b/src/Neon.Operator.Templates/OperatorTemplate/Finalizers/ExampleFinalizer.cs
@@ -1,14 +1,13 @@
-using System;
 using System.Threading.Tasks;
 
+using k8s;
+using k8s.Models;
+
 using Microsoft.Extensions.Logging;
 
 using Neon.Operator.Finalizers;
 using Neon.Tasks;
 
-using k8s;
-using k8s.Models;
-
 namespace OperatorTemplate
 {
     public class ExampleFinalizer : ResourceFinalizerBase<V1ExampleEntity>

diff --git a/src/Neon.Operator.Templates/OperatorTemplate/OperatorTemplate.csproj b/src/Neon.Operator.Templates/OperatorTemplate/OperatorTemplate.csproj
@@ -1,6 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
         <RootNamespace>OperatorTemplate</RootNamespace>
     </PropertyGroup>
+    <ItemGroup>
+        <PackageReference Include="Neon.Operator" Version="1.0.0-beta.21" />
+    </ItemGroup>
 </Project>
diff --git a/src/Neon.Operator.Templates/README.md b/src/Neon.Operator.Templates/README.md
@@ -0,0 +1,29 @@
+# Neon.Operator.Templates: Potentially useful libraries published as NuGet packages
+
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Operator.Templates?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Operator.Templates)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
+
+---
+
+This package contains a set of project templates for building Kubernetes operators in .NET.
+
+## Installation
+
+To install the template package, run the following command:
+
+```
+dotnet new install Neon.Operator.Templates::1.0.0-beta.21
+```
+
+Now you can create a new operator project using the following command:
+
+```
+dotnet new k8s-operator
+```
+
+## Documentation:
+- [Docs](https://docs.neonforge.com/docs/operator-sdk)
+
+Neon.Operator.Templates is an open source project released under the Apache-2.0 license.
diff --git a/src/Neon.Operator.Xunit/Neon.Operator.Xunit.csproj b/src/Neon.Operator.Xunit/Neon.Operator.Xunit.csproj
@@ -19,6 +19,7 @@
         <IsTestProject>false</IsTestProject>
         <NeonOperatorGenerateCrds>false</NeonOperatorGenerateCrds>
         <NeonOperatorGenerateRbac>false</NeonOperatorGenerateRbac>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
@@ -49,6 +50,7 @@
     <ItemGroup>
         <None Include="..\nuget-icon.png" Pack="true" PackagePath="" />
         <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
+        <None Include="README.md" Pack="true" PackagePath="" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/src/Neon.Operator.Xunit/README.md b/src/Neon.Operator.Xunit/README.md
@@ -1,4 +1,15 @@
-Neon.Kube.Xunit
-===============
+# Neon.Operator.Xunit
 
-**INTERNAL USE ONLY:** Core library used by neonKUBE related tooling.
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Operator.Xunit?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Operator.Xunit)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
+
+---
+
+A test framework for testing Neon.Operator operators using xUnit.
+
+## Documentation:
+- [Docs](https://docs.neonforge.com/docs/operator-sdk)
+
+Neon.Operator.Xunit is an open source project released under the Apache-2.0 license.
diff --git a/src/Neon.Operator/Neon.Operator.csproj b/src/Neon.Operator/Neon.Operator.csproj
@@ -15,6 +15,7 @@
         <PackageTags>kubernetes operator sdk neonkube k8s</PackageTags>
         <PackageReleaseNotes>https://github.com/nforgeio/operator-sdk/releases</PackageReleaseNotes>
         <DebugType>full</DebugType>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
@@ -61,6 +62,7 @@
         <None Include="..\nuget-icon.png" Pack="true" PackagePath="" />
         <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
         <None Include="build\*" Pack="true" PackagePath="build\" />
+        <None Include="README.md" Pack="true" PackagePath="" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Neon.Operator/README.md b/src/Neon.Operator/README.md
@@ -1,4 +1,15 @@
-Neon.Operator
-==================
+# Neon.Operator
 
-**INTERNAL USE ONLY:** Common code for neonKUBE operator implementations.
+[![.NET Test](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/nforgeio/operator-sdk/actions/workflows/test.yaml)
+[![NuGet Version](https://img.shields.io/nuget/v/Neon.Operator?style=flat&logo=nuget&label=NuGet)](https://www.nuget.org/packages/Neon.Operator)
+
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://communityinviter.com/apps/neonforge/neonforge)
+
+---
+
+A Kubernetes operator framework for .NET.
+
+## Documentation:
+- [Docs](https://docs.neonforge.com/docs/operator-sdk)
+
+Neon.Operator is an open source project released under the Apache-2.0 license.