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

[TC-408] Documentation for creating ssl keys is missing a field. #1001

Closed
limited opened this issue Aug 29, 2017 · 1 comment
Closed

[TC-408] Documentation for creating ssl keys is missing a field. #1001

limited opened this issue Aug 29, 2017 · 1 comment
Assignees
Labels
bug something isn't working as intended documentation related to documentation low impact affects only a small portion of a CDN, and cannot itself break one
Milestone

Comments

@limited
Copy link
Contributor

limited commented Aug 29, 2017

The documentation to generate ssl keys is missing the delivery service field. generating keys with that field being null will cause issues on Riak.

POST /api/1.2/deliveryservices/sslkeys/generate

Generates SSL crt, csr, and private key for a delivery service

Authentication Required: Yes

Role(s) Required: Admin

Request Properties

Parameter Type Description
key string xml_id of the delivery service
version string version of the keys being generated
hostname string the pristine hostname of the delivery service
country string
state string
city string
org string
unit boolean
Request Example

{
"key": "ds-01",
"businessUnit": "CDN Engineering",
"version": "3",
"hostname": "tr.ds-01.ott.kabletown.com",
"certificate": {
"key": "some_key",
"csr": "some_csr",
"crt": "some_crt"
},
"country": "US",
"organization": "Kabletown",
"city": "Denver",
"state": "Colorado"
}

These are the fields required. Notice the delivery service is null.

{
    "cdn": null,
    "certificate": {
        "crt": 
        "csr":         "key":     },
    "city": "Denver",
    "country": "US",
    "deliveryservice": null,
    "hostname": "*.linear-chi-pil-red.xcr.comcast.net",
    "key": "linear-chi-pil-red",
    "org": null,
    "state": "Colorado",
    "unit": "IPCDN",
    "version": "1"
}

Author: Joseph Pappano
JIRA Link: https://issues.apache.org/jira/browse/TC-408
Found Version: 2.1.0

@limited limited added this to the 2.1.0 milestone Aug 29, 2017
@limited limited added bug something isn't working as intended documentation related to documentation low impact affects only a small portion of a CDN, and cannot itself break one labels Aug 29, 2017
@hbeatty hbeatty self-assigned this Aug 30, 2017
@dneuman64 dneuman64 assigned dneuman64 and unassigned hbeatty Oct 6, 2017
dneuman64 added a commit to dneuman64/trafficcontrol that referenced this issue Oct 6, 2017
@hbeatty hbeatty closed this as completed in 9577cb6 Oct 9, 2017
@hbeatty
Copy link
Contributor

hbeatty commented Oct 9, 2017

This needs to be backported to 2.1.

@hbeatty hbeatty reopened this Oct 9, 2017
dneuman64 added a commit to dneuman64/trafficcontrol that referenced this issue Oct 9, 2017
hbeatty added a commit that referenced this issue Oct 10, 2017
@hbeatty hbeatty closed this as completed Oct 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug something isn't working as intended documentation related to documentation low impact affects only a small portion of a CDN, and cannot itself break one
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants