Guidance on running and testing operator locally

[tomkerkhove]

Do you have any guidance on running and testing an operator locally?

[buehler]

Hum... now that you mention it. I did not describe this in the documentation.

But it's fairly simple:
Create a KubeConfig locally that points to a cluster, and when you run the operator via dotnet run or your favorite IDE, it connects to the configured cluster in the kube-config.

As an example: I use it with docker desktop kubernets. Then I point the context of the kubeconfig to the docker cluster and run the operator.

[hemantkathuria]

I need some more clarity here please. I am still not able to debug the controller is my local. I am still figuring out the right way to debug.
On building the project it is generating the right yamls in the config folder. I have few basic questions.

Just doing the dotnet run --install does not make it work. The Kustomize file under "Install" has something like "newName: public-docker-image-path".

name: operator
newName: public-docker-image-path

I have enabled kubernetes in docker desktop. I did use the generated docker file to build the image with name "operator" and commented the line "newName" flag. It did not pick up the image from local docker images.

After that I pushed the image to ACR and specified the name in "newName" and added the image pull secret in operator/deployment.yam. Then I used Kubctl apply -k . to install all the files. At least I was able to run the operator in local kubernetes cluster. But have few issues.

1. On every build imagePullSecret goes away. How to retain the same?
2. How do I attach the debugger to the container in kubernetes. Doing dotnet run or F5 is giving the error.

: 'Cannot resolve scoped service 'KubeOps.Operator.Controller.IEventQueue`1[MyOperator.Entities.V1DemoEntity]' from root provider.'

Very sorry for asking the basics :)

[erin-allison]

1. On every build imagePullSecret goes away. How to retain the same?

You shouldn't edit the base files - it's Kustomize, you should create overlays.

: 'Cannot resolve scoped service 'KubeOps.Operator.Controller.IEventQueue`1[MyOperator.Entities.V1DemoEntity]' from root provider.'

See #441. This has been resolved already

[hemantkathuria]

Thank you for the response. I was actually on 6.5.1 already. I have upgraded to 6.5.3. But i am still seeing the issue when I do dotnet run.

dotnet run

info: KubeOps.Operator.Leadership.LeaderElector[0]
Startup Leader Elector for operator "myoperator".
Unhandled exception. System.InvalidOperationException: Cannot resolve scoped service 'KubeOps.Operator.Controller.IEventQueue1[MyOperator.Entities.V1DemoEntity]' from root provider. at Microsoft.Extensions.DependencyInjection.ServiceLookup.CallSiteValidator.ValidateResolution(Type serviceType, IServiceScope scope, IServiceScope rootScope) at Microsoft.Extensions.DependencyInjection.ServiceProvider.GetService(Type serviceType, ServiceProviderEngineScope serviceProviderEngineScope) at Microsoft.Extensions.DependencyInjection.ServiceLookup.ServiceProviderEngineScope.GetService(Type serviceType) at Microsoft.Extensions.DependencyInjection.ActivatorUtilities.ConstructorMatcher.CreateInstance(IServiceProvider provider) at Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance(IServiceProvider provider, Type instanceType, Object[] parameters) at KubeOps.Operator.Builder.OperatorBuilder.<>c__DisplayClass18_0.<AddOperatorBase>b__3(ControllerRegistration r) at System.Linq.Enumerable.SelectEnumerableIterator2.MoveNext()
at System.Collections.Generic.List1.InsertRange(Int32 index, IEnumerable1 collection)
at System.Collections.Generic.List1.AddRange(IEnumerable1 collection)
at KubeOps.Operator.Controller.ResourceControllerManager.StartAsync(CancellationToken cancellationToken)
at Microsoft.Extensions.Hosting.Internal.Host.StartAsync(CancellationToken cancellationToken)
at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
at Microsoft.Extensions.Hosting.HostingAbstractionsHostExtensions.RunAsync(IHost host, CancellationToken token)
at KubeOps.Operator.Commands.RunOperator.OnExecuteAsync()
at McMaster.Extensions.CommandLineUtils.Conventions.ExecuteMethodConvention.InvokeAsync(MethodInfo method, Object instance, Object[] arguments)
at McMaster.Extensions.CommandLineUtils.Conventions.ExecuteMethodConvention.OnExecute(ConventionContext context, CancellationToken cancellationToken)
at McMaster.Extensions.CommandLineUtils.Conventions.ExecuteMethodConvention.<>c__DisplayClass0_0.<b__0>d.MoveNext()
--- End of stack trace from previous location ---
at McMaster.Extensions.CommandLineUtils.CommandLineApplication.ExecuteAsync(String[] args, CancellationToken cancellationToken)

[erin-allison]

Oh, that's new - please open an issue with relevant details and someone will look when we have time. Discussions aren't really the right place for bug-hunting.

[hemantkathuria]

Ok sure, have created issue https://github.com/buehler/dotnet-operator-sdk/issues/450

[dbones]

I created this YT video, hopefully, it helps :D

https://youtu.be/ECiF2tksR7w