Update documentation for new commercial licensing API endpoints#4207
Update documentation for new commercial licensing API endpoints#4207RitvikPatil777 wants to merge 5 commits into
Conversation
github-actions
Bot
added
the
Documentation
Signed-off-by: Ritvik Patil <rpatil@progress.com>
Signed-off-by: Ritvik Patil <rpatil@progress.com>
RitvikPatil777
force-pushed
the
server_license_api_docs
branch
from
00ce994 to
323f12c
Compare
❌ Deploy Preview for chef-server failed.
|
👷 Deploy Preview for chef-server processing.
|
| @@ -1,5 +1,4 @@ | |||
| The `install` subcommand downloads packages from <https://packages.chef.io> by default. | |||
| For systems that are not behind a firewall (and have connectivity to <https://packages.chef.io>), these packages can be installed as described below. | |||
| The `install` subcommand downloads packages from <https://chefdownload-commercial.chef.io> by default (requires a valid `license_id`). | |||
There was a problem hiding this comment.
How do they pass in the license ID with this command?
There was a problem hiding this comment.
Updated to include the commercial download URL syntax and where license_id is passed (?license_id=<LICENSE_ID>).
| <https://packages.chef.io/> by default. For systems that are not behind | ||
| a firewall (and have connectivity to <https://packages.chef.io/>), the | ||
| Chef management console package can be installed as described below: | ||
| The `install` subcommand downloads packages from `chefdownload-commercial.chef.io` by default and requires a valid Progress Chef license ID. |
There was a problem hiding this comment.
Same question here. How do they pass in a license ID?
There was a problem hiding this comment.
The license ID is passed in the commercial install URL as a query parameter: ?license_id=<LICENSE_ID>.
Signed-off-by: Ritvik Patil <rpatil@progress.com>
There was a problem hiding this comment.
From what I understand, this won't work.
This would have to be rewritten entirely so that users download the chef-manage package from chefdownload-commercial and then use the --path option to install the package. E.g. sudo chef-server-ctl install PACKAGE_NAME --path /path/to/package/directory
This content would have to be merged with the following section where it documents using a local file path.
Unless the endpoint is updated in the install command.
There was a problem hiding this comment.
Another option is to remove this block of instructions entirely because Chef Manage is EOL. We shouldn't be telling people to install EOL things. I'm not sure what other packages can be installed with this command, though.
There was a problem hiding this comment.
@IanMadd since Chef Manage is EOL, the Chef Manage installation block has been removed.
| <https://packages.chef.io/> by default. For systems that are not behind | ||
| a firewall (and have connectivity to <https://packages.chef.io/>), the | ||
| Chef management console package can be installed as described below: | ||
| For commercial downloads, use the following URL: |
There was a problem hiding this comment.
It looks like the same issue here. Users would have to download packages from chefdownload-commercial, then use the --path option to install the package.
Signed-off-by: Ritvik Patil <rpatil@progress.com>
RitvikPatil777
force-pushed
the
server_license_api_docs
branch
from
7618b12 to
8370a61
Compare
2 participants
Summary
Updates Chef Server documentation to reference the new commercial licensing API endpoints.
Changes
packages.chef.ioreferences withchefdownload-commercial.chef.iolicense_idrequirement for commercial downloadsFiles Modified
docs-chef-io/content/server/ctl_chef_server.mddocs-chef-io/content/server/install_server_tiered.mddocs-chef-io/content/server/reusable/md/ctl_chef_server_install_features_download.md