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

Update grpc notes #1468

Merged
merged 1 commit into from
May 10, 2021
Merged

Update grpc notes #1468

merged 1 commit into from
May 10, 2021

Conversation

rafwegv
Copy link
Contributor

@rafwegv rafwegv commented Mar 19, 2021

Proposed changes

Update note about grpc unary support in documents

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto master
  • I will ensure my PR is targeting the master branch and pulling from my branch from my own fork

@rafwegv rafwegv self-assigned this Mar 19, 2021
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Mar 19, 2021
@Dean-Coakley
Copy link
Contributor

@@ -18,7 +18,8 @@ You can define App Protect policies for your Ingress resources by creating an `A

> **Note**: The fields `policy.signature-requirements[].minRevisionDatetime` and `policy.signature-requirements[].maxRevisionDatetime` are not currently supported.

> **Note**: [The Advanced gRPC Protection for Unary Traffic](/nginx-app-protect/configuration/#advanced-grpc-protection-for-unary-traffic) is not currently supported.
> **Note**: [The Advanced gRPC Protection for Unary Traffic](/nginx-app-protect/configuration/#advanced-grpc-protection-for-unary-traffic) only supports providing an `idl-file` inline. The fields `policy.idl-files[].link`, `policy.idl-files[].$ref`, and
`policy.idl-files[].file` are not supported. The IDL file should be provided in field `policy.idl-files[].contents`. The value of this field can be base64 encoded. In this case the field `policy.idl-files[].isBase64` should be set to `true`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`policy.idl-files[].file` are not supported. The IDL file should be provided in field `policy.idl-files[].contents`. The value of this field can be base64 encoded. In this case the field `policy.idl-files[].isBase64` should be set to `true`.
`policy.idl-files[].file` are not supported. The IDL file should be provided in the field `policy.idl-files[].contents`. The value of this field can be base64 encoded. In this case the field `policy.idl-files[].isBase64` should be set to `true`.

@pleshakov
Copy link
Contributor

@rafwegv is this PR still WIP?

@pleshakov pleshakov requested a review from lucacome May 4, 2021 23:41
@rafwegv rafwegv changed the title WIP: Update grpc notes Update grpc notes May 5, 2021
@rafwegv
Copy link
Contributor Author

rafwegv commented May 5, 2021

@pleshakov I kept it as WIP until the updated notes became true (grpc support was merged:) )

@rafwegv rafwegv merged commit a793823 into master May 10, 2021
@rafwegv rafwegv deleted the ap-grpc-docs branch May 10, 2021 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants