Make it possible to add annotations to the keys secret #3484

sdahlbac · 2023-10-11T11:48:02Z

Add command line option --keys-secret-annotations for specifying the annotations to be added to the keys secret when doing func kubernetes deploy

Tested manually using

--keys-secret-annotations reflector.v1.k8s.emberstack.com/reflection-allowed=true,reflector.v1.k8s.emberstack.com/reflection-auto-enabled=true,reflector.v1.k8s.emberstack.com/reflection-auto-namespaces=default

which renders the relevant bit of the keys secret like follows

...
kind: Secret
metadata:
  name: <name>
  annotations:
    reflector.v1.k8s.emberstack.com/reflection-allowed: "true"
    reflector.v1.k8s.emberstack.com/reflection-auto-enabled: "true"
    reflector.v1.k8s.emberstack.com/reflection-auto-namespaces: default

Issue describing the changes in this PR

resolves #3483

Pull request checklist

My changes do not require documentation changes I do not know, does it?
- Otherwise: Documentation issue linked to PR
My changes do not need to be backported to a previous version
- Otherwise: Backport tracked by issue/PR #issue_or_pr
I have added all required tests (Unit tests, E2E tests)

I have not ran nor added tests as I have a mac.

sdahlbac · 2023-10-11T11:49:15Z

@microsoft-github-policy-service agree

liliankasem · 2024-10-15T18:01:41Z

/azp run coretools.public

azure-pipelines · 2024-10-15T18:01:52Z

Azure Pipelines successfully started running 1 pipeline(s).

liliankasem · 2024-10-15T20:15:39Z

lgtm but I don't want to merge this in without tests; you should be able to write unit tests on a mac (it's my primary device as well). If you're not longer able to contribute to this PR, I can speak to the team about getting this reassigned!

sdahlbac · 2024-10-17T19:51:45Z

Is https://github.com/Azure/azure-functions-core-tools/blob/v4.x/CONTRIBUTING.md#running-the-test-suite incorrect then?

liliankasem · 2024-10-18T21:06:48Z

Is https://github.com/Azure/azure-functions-core-tools/blob/v4.x/CONTRIBUTING.md#running-the-test-suite incorrect then?

I believe it is outdated. It was written 7 years ago. My team just got ownership of this repo so we can work on updating this outdated information, but this might take some time given other priorities. You should be able to run tests like any normal c# project

sdahlbac · 2024-10-28T17:32:05Z

@liliankasem I just tried getting the tests to run, or even cd test/Azure.Functions.Cli.Tests; dotnet build:

Azure.Functions.Cli.Tests.csproj contains

  <Target Name="CopyInProc8" AfterTargets="Build" Condition="'$(TargetFramework)'=='net6.0'">
    <Exec Command="xcopy /Y /I /E &quot;$(MSBuildThisFileDirectory)..\..\src\Azure.Functions.Cli\bin\$(Configuration)\$(TargetFramework)\in-proc8\*&quot; &quot;$(OutDir)in-proc8\&quot;" />
  </Target>

which for obvious? reasons is not really working on OSX

making the tests work at all seems a bit out of scope for this PR IMO.

liliankasem · 2025-03-12T22:23:30Z

src/Azure.Functions.Cli/Kubernetes/KubernetesHelpers.cs

                if (eventInfo.Source.Type == typeof(string) && double.TryParse(eventInfo.Source.Value.ToString(), out _))
+                {
+                    eventInfo.Style = ScalarStyle.DoubleQuoted;
+                } else if (eventInfo.Source.Type == typeof(string) && bool.TryParse(eventInfo.Source.Value.ToString(), out _))
                {
                    eventInfo.Style = ScalarStyle.DoubleQuoted;
                }
+


Suggested change

if (eventInfo.Source.Type == typeof(string) && double.TryParse(eventInfo.Source.Value.ToString(), out _))

{

eventInfo.Style = ScalarStyle.DoubleQuoted;

} else if (eventInfo.Source.Type == typeof(string) && bool.TryParse(eventInfo.Source.Value.ToString(), out _))

{

eventInfo.Style = ScalarStyle.DoubleQuoted;

}

if (eventInfo.Source.Type == typeof(string) &&

(double.TryParse(eventInfo.Source.Value.ToString(), out _) ||

bool.TryParse(eventInfo.Source.Value.ToString(), out _)))

{

eventInfo.Style = ScalarStyle.DoubleQuoted;

}

liliankasem · 2025-03-12T22:24:09Z

@liliankasem I just tried getting the tests to run, or even cd test/Azure.Functions.Cli.Tests; dotnet build:

Azure.Functions.Cli.Tests.csproj contains
  <Target Name="CopyInProc8" AfterTargets="Build" Condition="'$(TargetFramework)'=='net6.0'">
    <Exec Command="xcopy /Y /I /E &quot;$(MSBuildThisFileDirectory)..\..\src\Azure.Functions.Cli\bin\$(Configuration)\$(TargetFramework)\in-proc8\*&quot; &quot;$(OutDir)in-proc8\&quot;" />
  </Target>
which for obvious? reasons is not really working on OSX

making the tests work at all seems a bit out of scope for this PR IMO.

Sorry for the delay here, I missed this. this code snippet no longer exists so that shouldn't be an issue. But tests on osx are still a pain :/ Given it's such a minor change and we are in the middle of refactoring the test project, I think it's okay to merge.

liliankasem

minor nit on if statement format

liliankasem · 2025-03-12T22:46:35Z

/azp run

azure-pipelines · 2025-03-12T22:46:46Z

Azure Pipelines successfully started running 1 pipeline(s).

liliankasem · 2025-03-12T22:49:49Z

src/Azure.Functions.Cli/Actions/KubernetesActions/KubernetesDeployAction.cs

@@ -93,6 +95,7 @@ public override ICommandLineParserResult ParseArgs(string[] args)
            SetFlag<string>("config-file", "if --write-configs is true, write configs to this file (default: 'functions.yaml')", f => ConfigFile = f);
            SetFlag<string>("hash-files", "Files to hash to determine the image version", f => HashFilesPattern = f);
            SetFlag<bool>("image-build", "If false, skip the docker build", f => BuildImage = f);
+            SetFlag<string>("keys-secret-annotations", "The annotations to add to the keys secret e.g. key1=val1,key2=val2", a => KeysSecretAnnotations = a.Split(',').Select(s => s.Split('=')).ToDictionary(k => k[0], v => v[1]));


nit:

Suggested change

SetFlag<string>("keys-secret-annotations", "The annotations to add to the keys secret e.g. key1=val1,key2=val2", a => KeysSecretAnnotations = a.Split(',').Select(s => s.Split('=')).ToDictionary(k => k[0], v => v[1]));

SetFlag<string>("key-secret-annotations", "The annotations to add to the keys secret e.g. key1=val1,key2=val2", a => KeySecretAnnotations = a.Split(',').Select(s => s.Split('=')).ToDictionary(k => k[0], v => v[1]));

Make it possible to add annotations to the keys secret

8826ed2

sdahlbac requested review from khkh-ms and amamounelsayed as code owners October 11, 2023 11:48

liliankasem previously approved these changes Oct 15, 2024

View reviewed changes

liliankasem self-requested a review October 15, 2024 20:14

Merge branch 'v4.x' into keys-annotations-3483

c9f32dd

liliankasem dismissed their stale review via c9f32dd October 17, 2024 18:16

liliankasem requested a review from a team as a code owner October 17, 2024 18:16

sdahlbac added 3 commits October 28, 2024 19:12

fix inconsistent naming

93860ef

we need to quote booleans as well

25a9a25

fix naming

0c9c5a1

aishwaryabh changed the base branch from v4.x to main November 26, 2024 20:25

liliankasem reviewed Mar 12, 2025

View reviewed changes

liliankasem approved these changes Mar 12, 2025

View reviewed changes

liliankasem reviewed Mar 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make it possible to add annotations to the keys secret #3484

Make it possible to add annotations to the keys secret #3484

sdahlbac commented Oct 11, 2023

sdahlbac commented Oct 11, 2023

liliankasem commented Oct 15, 2024

azure-pipelines bot commented Oct 15, 2024

liliankasem commented Oct 15, 2024

sdahlbac commented Oct 17, 2024

liliankasem commented Oct 18, 2024

sdahlbac commented Oct 28, 2024

liliankasem Mar 12, 2025

liliankasem commented Mar 12, 2025

liliankasem left a comment

liliankasem commented Mar 12, 2025

azure-pipelines bot commented Mar 12, 2025

liliankasem Mar 12, 2025

	SetFlag<string>("keys-secret-annotations", "The annotations to add to the keys secret e.g. key1=val1,key2=val2", a => KeysSecretAnnotations = a.Split(',').Select(s => s.Split('=')).ToDictionary(k => k[0], v => v[1]));
	SetFlag<string>("key-secret-annotations", "The annotations to add to the keys secret e.g. key1=val1,key2=val2", a => KeySecretAnnotations = a.Split(',').Select(s => s.Split('=')).ToDictionary(k => k[0], v => v[1]));

Make it possible to add annotations to the keys secret #3484

Are you sure you want to change the base?

Make it possible to add annotations to the keys secret #3484

Conversation

sdahlbac commented Oct 11, 2023

Issue describing the changes in this PR

Pull request checklist

sdahlbac commented Oct 11, 2023

liliankasem commented Oct 15, 2024

azure-pipelines bot commented Oct 15, 2024

liliankasem commented Oct 15, 2024

sdahlbac commented Oct 17, 2024

liliankasem commented Oct 18, 2024

sdahlbac commented Oct 28, 2024

liliankasem Mar 12, 2025

Choose a reason for hiding this comment

liliankasem commented Mar 12, 2025

liliankasem left a comment

Choose a reason for hiding this comment

liliankasem commented Mar 12, 2025

azure-pipelines bot commented Mar 12, 2025

liliankasem Mar 12, 2025

Choose a reason for hiding this comment