Add support for Nirmata,cloud-native application management #298

itsCheithanya · 2023-06-18T09:18:35Z

Overview

Type of change

Created a new plugin
Improved an existing plugin
Fixed a bug in an existing plugin
Improved contributor utilities or experience

Related Issue(s)

Resolves: #
Relates: #

How To Test

Download nctl CLI from here
Run the command
nctl info
to get

Changelog

arunsathiya · 2023-06-24T07:04:40Z

As noted on the other comment, we'd like to see the "Overview" section of the PR description filled out.

hculea

Thank you for your contribution! I've left some suggestions, please let us know if you have any questions! 😄

hculea · 2023-06-24T11:08:44Z

plugins/nirmata/api_token.go

+ if section.HasKey("address") && section.Key("address").Value() != "" {
+ fields[fieldname.Address] = section.Key("address").Value()
+ }
+ if section.HasKey("email") && section.Key("email").Value() != "" {
+ fields[fieldname.Email] = section.Key("email").Value()
+ }
+ if section.HasKey("token") && section.Key("token").Value() != "" {
+ fields[fieldname.Token] = section.Key("token").Value()


I see there is a reference to fieldname.URL in the default envvar mapping, but we never import this field.

Let's make sure that our import candidates comply with the structure that the provider expects. 😄

Yeah I've done the change

hculea · 2023-06-24T11:10:19Z

plugins/nirmata/nctl.go

+ needsauth.NotForHelpOrVersion(),
+ needsauth.NotWithoutArgs(),


Let's opt out of authentication for nctl login as well. 😄

yess getit!!

Thanks! I'm not familiar with the Nirmata CLI, are there any other commands which do not require authentication?

I believe version does not require authentication, but could you confirm the rest, @itsCheithanya?

hculea · 2023-06-24T11:11:42Z

plugins/nirmata/api_token.go

+var defaultEnvVarMapping = map[string]sdk.FieldName{
+ "NIRMATA_TOKEN": fieldname.Token,
+ "NIRMATA_URL": fieldname.URL,
+}


I see we import and require an email, but only provision the token and URL. Is the email something that is required as well?

Otherwise, let's consider making it optional, or, alternatively, omitting it from the importer.

hculea

Thanks! Moving in the right direction, let's go 🚀

hculea · 2023-06-26T10:06:33Z

plugins/nirmata/api_token.go

+ Name: fieldname.Email,
+ MarkdownDescription: "Email address registered in Nirmata.",


Is the email required in the item, since it's not provisioned?

But it should be used for this command nctl login which prompts for all these fields including email

With this shell plugin, the user should no longer have to run nctl login. From what I can find in the documentation (Alternatively, you can use global flags or set the NIRMATA_TOKEN and NIRMATA_URL environment variables.), this is an alternative to the email-based authentication.

Okay in that way makes sense

So should we now make the URL field required and not optional?

No, since the docs state that the URL has a default:

--url string the URL address for Nirmata (env NIRMATA_URL) (default "https://nirmata.io")

so not provisioning it would not break the users' workflows.

oh okay so should I only import token from the config file?

It's okay to also import url from the config file. At provisioning time, if there's nothing to provision for the url, then we can use the default value

hculea · 2023-06-26T10:06:46Z

plugins/nirmata/api_token.go

+ DocsURL: sdk.URL("https://nirmata.com/docs/api_token"), // TODO: Replace with actual URL
+ ManagementURL: sdk.URL("https://console.nirmata.com/user/security/tokens"), // TODO: Replace with actual URL


These URLs don't work for me 🤔

ohh yeahh I should change it,I didn't find proper documentation about the CLI ,this is the only where it is mentioned
https://downloads.nirmata.io/nctl/downloads/

hculea · 2023-06-26T10:08:26Z

plugins/nirmata/api_token.go

+ if section.HasKey("email") && section.Key("email").Value() != "" {
+ fields[fieldname.Email] = section.Key("email").Value()
+ }


I don't think we need to import this, since it's not provisioned to the commands.

Yess i feel you are correct ill try without email

hculea · 2023-06-26T10:09:17Z

plugins/nirmata/nctl.go

+ needsauth.NotForHelpOrVersion(),
+ needsauth.NotWithoutArgs(),


Thanks! I'm not familiar with the Nirmata CLI, are there any other commands which do not require authentication?

hculea · 2023-06-26T10:09:36Z

plugins/nirmata/plugin.go

+ Name: "nirmata",
+ Platform: schema.PlatformInfo{
+ Name: "Nirmata",
+ Homepage: sdk.URL("https://nirmata.com"), // TODO: Check if this is correct


Let's remove the TODO from here.

yess into it

@itsCheithanya This does not seem to be removed yet, could we make sure to remove it, please?

hculea · 2023-06-26T10:09:51Z

plugins/nirmata/plugin.go

+ Name: "nirmata",
+ Platform: schema.PlatformInfo{
+ Name: "Nirmata",
+ Homepage: sdk.URL("https://nirmata.com"), // TODO: Check if this is correct


Let's remove the TODO from here.

hculea · 2023-06-26T10:10:09Z

plugins/nirmata/api_token_test.go

+func TestAPITokenImporter(t *testing.T) {
+ plugintest.TestImporter(t, APIToken().Importer, map[string]plugintest.ImportCase{
+ "environment": {
+ Environment: map[string]string{ // TODO: Check if this is correct


Let's remove the TODO from here.

itsCheithanya · 2023-06-30T10:01:32Z

@arunsathiya @hculea you can review it

arunsathiya

I have just had a chance to review the code, and it looks like a good start, @itsCheithanya. Thank you. A lot of functional testing will be required though and for us to do it, could you help us with some details?

What is Nirmata?
How does nirmata.com differ from nirmata.io?
From this page, nctl and nadm are different CLI. Would you know what each does?
And from this page, Nirmata Enterprise for Kyverno and Nirmata Policy Manager are two different things as well. Which of those two platforms is the proposed shell plugin targeting?

Lastly but not the least, could you share some screenshots of the shell plugin in action? It'd help a ton with the reviews.

I usually recommend sharing some screenshots/videos to back up the proposed changes in any PR, thanks Cheithanya!

arunsathiya · 2023-07-06T01:39:11Z

plugins/nirmata/plugin.go

+ Name: "nirmata",
+ Platform: schema.PlatformInfo{
+ Name: "Nirmata",
+ Homepage: sdk.URL("https://nirmata.com"), // TODO: Check if this is correct


@itsCheithanya This does not seem to be removed yet, could we make sure to remove it, please?

arunsathiya · 2023-07-06T01:39:43Z

plugins/nirmata/nctl.go

+ return schema.Executable{
+ Name: "Nirmata CLI",
+ Runs: []string{"nctl"},
+ DocsURL: sdk.URL("https://nirmata.com/docs/cli"), // TODO: Replace with actual URL


This todo as well.

arunsathiya · 2023-07-06T01:40:00Z

plugins/nirmata/nctl.go

+ needsauth.NotForHelpOrVersion(),
+ needsauth.NotWithoutArgs(),


I believe version does not require authentication, but could you confirm the rest, @itsCheithanya?

arunsathiya · 2023-07-06T01:40:32Z

plugins/nirmata/api_token.go

+ if section.HasKey("address") && section.Key("address").Value() != "" {
+ fields[fieldname.Address] = section.Key("address").Value()
+ }
+ // if section.HasKey("email") && section.Key("email").Value() != "" {


Let's completely remove this block instead of leaving them as commented sections.

@itsCheithanya this is still commented

plugins/nirmata/api_token.go

arunsathiya · 2023-07-06T01:41:11Z

plugins/nirmata/api_token.go

+ Fields: fields,
+ })
+ }
+


A couple of empty lines in this file as well.

arunsathiya · 2023-07-06T01:41:44Z

plugins/nirmata/api_token_test.go

+ },
+ },
+ },
+


An empty line here. Let's remove it.

arunsathiya · 2023-07-06T01:43:45Z

plugins/nirmata/plugin.go

+ Name: "nirmata",
+ Platform: schema.PlatformInfo{
+ Name: "Nirmata",
+ Homepage: sdk.URL("https://nirmata.com"), // TODO: Check if this is correct


It looks like nirmata.com and nirmata.io are two different products/services, but from the same company? Could you share some specifics of what you know about Nirmata? That'd help us reviewers jumpstart the process, vs having to understand the Nirmata concepts manually. Thanks @itsCheithanya!

itsCheithanya · 2023-07-07T13:48:02Z

I have just had a chance to review the code, and it looks like a good start, @itsCheithanya. Thank you. A lot of functional testing will be required though and for us to do it, could you help us with some details?
* What is Nirmata?

* How does nirmata.com differ from nirmata.io?

* From [this page](https://downloads.nirmata.io/), nctl and nadm are different CLI. Would you know what each does?

* And from [this page](https://www.nirmata.io/security/signup.html?referrer=homepage), Nirmata Enterprise for Kyverno and Nirmata Policy Manager are two different things as well. Which of those two platforms is the proposed shell plugin targeting?
Lastly but not the least, could you share some screenshots of the shell plugin in action? It'd help a ton with the reviews.

I usually recommend sharing some screenshots/videos to back up the proposed changes in any PR, thanks Cheithanya!
nirmata.com is used for the company's main website, providing information about the products, solutions, and services offered by Nirmata. On the other hand, nirmata.io is used to login to nirmata platform

nctl: nctl is used to interact with the Nirmata platform and perform various management tasks related to deploying and managing applications, environments, and other resources. It offers commands for managing application lifecycle, cluster provisioning, user management, and more.
nadm: nadm is another CLI tool provided by Nirmata to install Nirmata software

This plugin is focussed on Nirmata Policy Manager as it supports api keys with nctl cli

AndyTitu · 2023-08-30T11:50:10Z

@itsCheithanya as next steps, it would be awesome if you could share a video of the plugin working as expected.

There are also a couple of comments which are pending resolution.

hculea · 2023-09-19T13:12:46Z

Hey @itsCheithanya - reaching out again, is there anything that we can help with to move this forward? 🚀

hculea · 2023-09-22T11:18:31Z

Closing because of inactivity - please feel free to re-open the PR if you'd like to pick this back up @itsCheithanya 🚀

itsCheithanya added 2 commits June 18, 2023 13:11

nirmata plugin

e824055

nirmata plugin functionality

979a137

arunsathiya assigned itsCheithanya Jun 23, 2023

arunsathiya self-requested a review June 23, 2023 20:28

arunsathiya added the in-progress this PR is being worked on/comments are in the process of being addressed by the contributor label Jun 23, 2023

arunsathiya mentioned this pull request Jun 23, 2023

Add support for docker cli login using Username and Email plugin #301

Closed

4 tasks

hculea reviewed Jun 24, 2023

View reviewed changes

required changes done

e30eeec

hculea reviewed Jun 26, 2023

View reviewed changes

itsCheithanya added 2 commits June 28, 2023 00:26

changes

bcf129c

changes done and test cases passed

c01ba9a

arunsathiya reviewed Jul 6, 2023

View reviewed changes

arunsathiya added in-progress this PR is being worked on/comments are in the process of being addressed by the contributor and removed waiting-on-reviewer signals that a certain PR is waiting for a review from a 1Password team member labels Jul 6, 2023

arunsathiya self-requested a review July 6, 2023 16:29

arunsathiya added waiting-on-reviewer signals that a certain PR is waiting for a review from a 1Password team member and removed in-progress this PR is being worked on/comments are in the process of being addressed by the contributor labels Jul 24, 2023

AndyTitu added in-progress this PR is being worked on/comments are in the process of being addressed by the contributor and removed waiting-on-reviewer signals that a certain PR is waiting for a review from a 1Password team member labels Aug 30, 2023

hculea closed this Sep 22, 2023

		Name: fieldname.Email,
		MarkdownDescription: "Email address registered in Nirmata.",

		DocsURL: sdk.URL("https://nirmata.com/docs/api_token"), // TODO: Replace with actual URL
		ManagementURL: sdk.URL("https://console.nirmata.com/user/security/tokens"), // TODO: Replace with actual URL

Add support for Nirmata,cloud-native application management #298

Add support for Nirmata,cloud-native application management #298

Conversation

itsCheithanya commented Jun 18, 2023

Overview

Type of change

Related Issue(s)

How To Test

Changelog

arunsathiya commented Jun 24, 2023

hculea left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hculea left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itsCheithanya Jun 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itsCheithanya commented Jun 30, 2023

arunsathiya left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itsCheithanya commented Jul 7, 2023 • edited Loading

AndyTitu commented Aug 30, 2023

hculea commented Sep 19, 2023

hculea commented Sep 22, 2023

itsCheithanya Jun 27, 2023 •

edited

Loading

itsCheithanya commented Jul 7, 2023 •

edited

Loading