Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CHEF-3917 Troubleshooting Page for Chef Licensing issues/errors #6612

Merged
merged 7 commits into from
Oct 19, 2023

Conversation

Nik08
Copy link
Contributor

@Nik08 Nik08 commented Aug 18, 2023

Description

Troubleshooting Page for Chef Licensing issues/errors

  1. Connection Error
  2. File format corruption Error
  3. Software Entitlement Issue

Related Issue

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change)
  • Breaking change (a content change which would break existing functionality or processes)

Checklist:

  • I have read the CONTRIBUTING document.

@netlify
Copy link

netlify bot commented Aug 18, 2023

Deploy Preview for chef-inspec ready!

Name Link
🔨 Latest commit 926216f
🔍 Latest deploy log https://app.netlify.com/sites/chef-inspec/deploys/6530e3c5db4c540008324945
😎 Deploy Preview https://deploy-preview-6612--chef-inspec.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added the Documentation ZH multi-repo label for the docs-team label Aug 18, 2023
@Nik08 Nik08 marked this pull request as ready for review August 21, 2023 11:14
@Nik08 Nik08 requested review from a team as code owners August 21, 2023 11:14
@Nik08 Nik08 changed the title Troubleshooting Page for Chef Licensing issues/errors CHEF-3917 Troubleshooting Page for Chef Licensing issues/errors Aug 22, 2023

This error encountered with Chef InSpec, version 6 or higher, is specifically related to `licenses.yaml` file.
It indicates that the version of file format used in the file is either unsupported or is invalid.
It is a requirement for `licenses.yaml` file to use the latest supported file format version.
Copy link
Contributor

@IanMadd IanMadd Aug 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't seen a license.yaml file in the install docs in #6574. We should add reference to this file there or delete these two sections here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We definitely need these 2 sections here because these errors can happen. So maybe we should include this on install docs. Thoughts @clintoncwolfe ?


- Service Availability: If it's a Local Licensing Service, ensure that it's properly configured and operational. Any misconfigurations or issues with the local service could lead to connection problems.

- URL Configuration: Verify that the URL configured in Chef InSpec is correct. If the URL is configured using an environment variable, check the value for environment variable `CHEF_LICENSE_SERVER` to confirm the configured URL.
Copy link
Contributor

@IanMadd IanMadd Aug 24, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would the inspec license list command help with this? I ask because there's also the --chef-license-server CLI option.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think inspec license list can not be used for this purpose. And yes we have this --chef-license-server CLI option as well, but how to check the server URL value if it was set using this CLI option? I did not have any easy resolution on this. So, I only mentioned this for ENV usage.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If someone uses the env variable, is that stored in the InSpec config file?

Copy link
Contributor Author

@Nik08 Nik08 Aug 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The value is set only in env and not in inspec config. But we store this value in licenses.yaml

@IanMadd
Copy link
Contributor

IanMadd commented Oct 10, 2023

I think this is ready to go aside from the merge conflict.

Nik08 and others added 7 commits October 19, 2023 13:35
Signed-off-by: Nik08 <nikita.mathur@progress.com>
Signed-off-by: Nik08 <nikita.mathur@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>

Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
@Nik08 Nik08 force-pushed the nm/troubleshoot-chef-licensing branch from 1ce248e to 926216f Compare October 19, 2023 08:07
@Nik08 Nik08 merged commit b607ccc into main Oct 19, 2023
5 of 7 checks passed
@Nik08 Nik08 deleted the nm/troubleshoot-chef-licensing branch October 19, 2023 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation ZH multi-repo label for the docs-team inspec-6
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants