Licensing

[brianbancroft]

In MKE-Dashboard, the licensing page will point to a licensing docs page for more information and one does not exist yet.

What is needed

• How to procure a new license (including contact points) for those who are unaware
• Anything relevant from https://docs.mirantis.com/mke/3.7/install/obtain-license.html?highlight=license

[byDimasik]

License can be set either via config file or UI.

Config

The config way is straightforward

1. Set the license token under spec.license.token

   spec:
   license:
     token: <your-license-token>

2. Run mkectl apply

To check the license status, users can see the status of the mkeconfig resource

kubectl -n mke get mkeconfig mke -ojsonpath="{.status.licenseStatus}" | jq 

Example output

{
  "expiration": "2027-10-10T07:00:00Z",
  "licenseType": "Offline",
  "maxEngines": 10,
  "scanningEnabled": true,
  "subject": "sf|0014W0000341gYFQAY|a2X4W000000ZeatUAC",
  "tier": "Production"
}

UI

UI should be almost identical to what we have in MKE 3 docs

Just the upload button is named differently and in addition to uploading a file we allowed pasting the token as a string into a text box. @brianbancroft do you have a screenshot of the most recent version of the license page

[brianbancroft]

@byDimasik I'm not asking for a technical solution. This help page is meant as a first step towards an administrative solution.

This is where a user would likely access the page from:

[rachaelbrownie]

That said, the "learn more" in the screenshot above could be good to go to a page with the content that you have written here (so long as we update the text next to the link to not be misleading, as Brian said) @byDimasik, but then to address the concern Brian has raised for this specific issue, we should also need some place to direct users to that describes how to purchase/renew a license; whether thats a page, a phone number, email etc).

We could have two separate pages or one page. either way, but we need both. And they should link to each other if they are separate.

There is also a link in the License Banner to "purchase a license" and it would need to go directly to somewhere they can purchase/renew or learn how to purchase/renew as well.

[rachaelbrownie]

Moreover, once they are on the page for adding a License, documentation on how to get there or how to update it by CLI probably isn't that helpful 😅 . So it's good to have, but yeah, not specifically what we are looking for here.

[brianbancroft]

here is a cleaned, clear screenshot on the page used to add a license as well.

[brianbancroft]

Still noticing that the obtain-license.md has plenty on how to use a license. Will there be instructions on how to obtain a license? https://github.com/Mirantis/mke-docs/blob/32044c349da238aadd7910716bd4cf7beecbf0b2/content/docs/getting-started/obtain-license.md

[MagdaDziadosz]

I used the sources and examples provided in this issue to create this document. The name and most of the content reflects Obtain the license in MKE 3. If you want me to add more on how to obtain a license, I would need some input content for that part. If such content is not available at the moment, will you be open to changing the name to “Licensing” or something similar to be less misleading for the users.

[ry4nz]

@MagdaDziadosz If we’re currently missing details on obtaining a license in MKE 4, what would you recommend the page should include to ensure it’s clear and useful for users? Your insights as both a writer and potential user would be highly valuable.

[MagdaDziadosz]

@ry4nz @brianbancroft Currently, the licensing page includes more information than the one in MKE 3, we have a link to a contact form and explanation on how to apply the license through the UI as well as configuration file. Technical documentation is a place where users seek information after they start using the product. However, if you think adding a link to a pricing page or email address of our sales department would be beneficial, I can certainly do so (you just need to provide it). That being said, obtaining a license seems like a main page topic. The main page is where the customers will first look for information on a product and pricing.

[rachaelbrownie]

I actually didn't see the PR that was attached to this until just now.

@MagdaDziadosz How about just below Users are not authorized to run MKE without a valid license. For more information, refer to [Mirantis Agreements and Terms](https://legal.mirantis.com/). we add a line:

"If you are need a license or your license has expired please contact [x] or go to [Y]"

Maybe that's all we need. I agree that users coming to this page probably already have purchased but I think an extra link to where to give us money cant hurt.

Otherwise the PR looks great IMO and should definitely solve what we need. Unless @ry4nz or @brianbancroft think there is still something missing besides that.

[rachaelbrownie]

And once its good i will update the link on the Licensing page in the UI to link to this. To confirm @MagdaDziadosz , the URL will be: https://mirantis.github.io/mke-docs/docs/getting-started/obtain-license?

[MagdaDziadosz]

@rachaelbrownie We can add "If you need a license or your license has expired, please contact [x] or go to [Y]" at a later date, once we have X and Y provided. Currently, the link looks like this: https://mirantis.github.io/mke-docs/docs/getting-started/licensing-mke4/

[rachaelbrownie]

@MagdaDziadosz Just to confirm, you need us to provide the x and y to you? Just want to make sure were not waiting on you and you waiting on us 😅

[MagdaDziadosz]

@rachaelbrownie yes, I don't know who the customers need to contact to obtain the license, so if such information is to be included in the documentation, you need to provide all the details.