Skip to content

Update comment for credentialName #786

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.

Sign up for GitHub

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

Merged
wenchenglu merged 2 commits into from
Feb 6, 2019
Merged

Update comment for credentialName #786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ef4f01
Update comment for credentialName
JimmyCYJ Feb 6, 2019
2117c4d
Update comment
JimmyCYJ Feb 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions networking/v1alpha3/gateway.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 12 additions & 9 deletions networking/v1alpha3/gateway.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,15 +305,18 @@ message Server {
string ca_certificates = 5;

// The credentialName stands for a unique identifier that can be used
// to identify the serverCertificate, the privateKey and the
// CaCertificates associated with this server. Gateway workloads
// capable of fetching credentials from a remote credential store will
// be configured to retrive the credentials using this name, instead of
// using the file system paths specified above. The semantics of the
// name are platform dependent. In Kubernetes, the default Istio
// supplied credentail server expects the credentialName to match the
// name of the Kubernetes secret that holds the server certificate, the
// private key, and the CA certificate (if using mutual TLS).
// to identify the serverCertificate and the privateKey. The credentialName
// appended with suffix "-cacert" is used to identify the CaCertificates
// associated with this server. Gateway workloads capable of fetching
// credentials from a remote credential store will be configured to retrieve
// the serverCertificate and the privateKey using credentialName, instead of
// using the file system paths specified above. If using mutual TLS,
// gateway workloads will retrieve the CaCertificates using
// credentialName-cacert. The semantics of the name are platform dependent.
// In Kubernetes, the default Istio supplied credential server expects the
// credentialName to match the name of the Kubernetes secret that holds the
// server certificate, the private key, and the CA certificate
Copy link
Copy Markdown
Member

@rshriram rshriram Feb 6, 2019

Choose a reason for hiding this comment

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

and if using mTLS, "credentialName-cacert" to match the name of the Kubernetes secret that holds the CA certificate.

Copy link
Copy Markdown
Member Author

@JimmyCYJ JimmyCYJ Feb 6, 2019

Choose a reason for hiding this comment

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

If using mTLS, customer only creates one k8s secret with credentialName (e.g. "foo.credential"), Pilot creates two SDS configs for gateway listener, one is named "foo.credential", and is used to fetch key and cert. The other is named "foo.credential-cacert", and is used to fetch certificate validation context that has CA cert. So I think the comment is okay.

// (if using mutual TLS).
string credential_name = 10;

// A list of alternate names to verify the subject identity in the
Expand Down
21 changes: 12 additions & 9 deletions networking/v1alpha3/istio.networking.v1alpha3.pb.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.