kyma-project / examples Goto Github PK
View Code? Open in Web Editor NEWKyma use cases
License: Apache License 2.0
Kyma use cases
License: Apache License 2.0
Add a new Compass topic to the Kyma documentation and provide some basic docs with Compass description. Base on the Content Strategy when creating new documents.
Confirm these statements before you submit the issue:
Description
Resources in gateway example should use simplified hostnames to ensure the ability to run and use them on different clusters.
Expected result
After applying example API from gateway samples with simple host, I can access my service on the domain I'm currently working on.
Actual result
Currently, they refer to *.kyma.local.
Description
Migrate tests/kubeless-integration pipeline from Jenkins to Prow.
Migration guide is available here: https://github.com/kyma-project/test-infra/blob/master/docs/prow/migration-guide.md
Please, also update the table in this issue kyma-project/test-infra#118 after migration is done.
Confirm these statements before you submit the issue:
Description
The goal of the already existing event-email-service is to demonstrate the e2e scenario of
Currently the example just receives an event, so the leftovers still need to be implemented.
Acceptance Criteria
Description
Migrate tests/http-db-service/ pipeline from Jenkins to Prow.
Migration guide is available here: https://github.com/kyma-project/test-infra/blob/master/docs/prow/migration-guide.md
Please, also update the table in this issue kyma-project/test-infra#118 after migration is done.
Confirm these statements before you submit the issue:
Description
Currently the examples have local tests which are assuring that they work isolated.
We need tests assuring that they will work when applied to a Kyma cluster. Especially examples consisting only of yaml files needs to be tested against a Kyma cluster.
Goal is to have one helm chart where you can configure the installation of an example together with tests, so that you can install and test all/selectively the examples on any Kyma cluster.
Acceptance Criteria
Description
Provide an example how developer can establish secure tunnel from Kyma cluster to the application running on the local machine and ensure that bidirectional communication works (sending events from application to Kyma and calling APIs on local system).
Reasons
Developers prefer to use systems running on their local machine. The cannot easily connect those systems to Kyma as their machines are usually not reachable from the Kyma cluster (internal IP, firewalls, NAT).
A violation against the OSS Rules of Play has been detected.
Rule ID: rl-reuse_tool-3
Explanation: Is it registered in REUSE? No
Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html
Description
Rename any occurrences of Environments into Namespaces in all *.md
files in the example
repository.
Description
I just compared the ServiceBindingUsage
that is created via the UI against the example that is provided in https://github.com/kyma-project/examples/tree/master/service-binding/lambda.
I see that the following section is added via the UI, which is not available in the example:
spec:
parameters:
envPrefix:
name: ""
Expected result
The Service Binding is reflected in the UI of Lambda details.
Actual result
Without this parameters section in the example, the Service Binding is not displayed in the UI of Kyma.
Steps to reproduce
Follow the example as it is. Later just add the parameters
section below spec
in the ServiceBindingUsage and try it again. The Binding is then shown in the UI.
Troubleshooting
none.
A violation against the OSS Rules of Play has been detected.
Rule ID: rl-reuse_tool-4
Explanation: Is it compliant with REUSE rules? No
Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html
Hello,
I've noticed some difference between the example serverless python runtime docker image and the one running in my Kyma cluster.
Could you please either:
Description
Reference image for python runtime seems outdated.
Reasons
I need to customize the python runtime image (only to apt install
an OS package). I don't want to encounter regressions because I used an outdated reference image.
Thanks.
A violation against the OSS Rules of Play has been detected.
Rule ID: rl-reuse_tool-1
Explanation: Does README mention REUSE? No
Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html
Hi Kyma team,
Is there a way to call a url to get JWT token like getting the Oauth token in the example ?
I am trying to have a client get the JWT token using a call instead of manual step of getting it from the kubeconfig like in the example docs.
Thanks,
Sunar
Description
Following example is not correct: https://github.com/kyma-project/examples/blob/master/service-binding/lambda/README.md
I've encountered the following issues while executing this example step by step:
kubectl get servicebinding/redis-instance-binding -o jsonpath='{ .status.conditions[0].reason }' -n $KYMA_EXAMPLE_NS
, but at this step, the binding doesn't exist, we create it in the next step.ERRO[0000]
FATA[0000] the server is currently unable to handle the request (get services redis-client:http-function-
Expected result
Example scenario can be executed step by step for anyone.
Actual result
We can't call lambda at the end and we get troubles with the test scenario steps
Steps to reproduce
Just follow the test scenario
Description
Migrate http-db-service example pipeline from Jenkins to Prow.
Migration guide is available here: https://github.com/kyma-project/test-infra/blob/master/docs/prow/migration-guide.md
Please, also update the table in this issue kyma-project/test-infra#118 after migration is done.
There are istio AUTH specific annotations contained in the yaml files of the examples which are not required anymore and should be removed.
for a service
annotations:
auth.istio.io/XXX: NONE
In the event-subscription example README file, the curl command to publish an event uses an incorrect source namespace: "source-namespace": "com.github"
which should be "source-namespace": "local.kyma.commerce"
according to the subscription specs.
Description
Migrate event-email-service example pipeline from Jenkins to Prow.
Migration guide is available here: https://github.com/kyma-project/test-infra/blob/master/docs/prow/migration-guide.md
Please, also update the table in this issue kyma-project/test-infra#118 after migration is done.
Merge after-arch-docu
branch with Ralph's documents into master
.
Description
In Gateway example the flow of the document suggests, that user can expose two different APIs (secured and unsecured) at the same time while this is not possible. Only the first one will be created and the second will contain error in object status (which is not showed in UI). Example needs to be clear that two APIs may not exist at the same time.
Expected result
Actual result
Steps to reproduce
Follow blindly the example ;)
Troubleshooting
A violation against the OSS Rules of Play has been detected.
Rule ID: rl-vulnerability_alerts-1
Explanation: Are vulnerability alerts enabled? No
Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html
The api resources used in the examples are using an outdated crd group name, it should be: gateway.kyma-project.io
Description
Iterate over all resource definitions in the examples and check for existence and consistent usage of the app label, especially for functions.
Reasons
Many kubernetes tooling is based on the app label and will work out of the box if it is used. So the recommended code snippets should use it as well. See also kyma-project/kyma#3953
Description
The example https://github.com/kyma-project/examples/tree/master/service-binding/lambda does not work. The step "Trigger the function" gives the result:
ERRO[0000]
FATA[0000] an error on the server ("Error: 'EOF'
Trying to reach: 'http://10.28.3.28:8080/'") has prevented the request from succeeding (get services redis-client:http-function-port)
Expected result
The step 7 contains a command which triggers the function.
Actual result
Could not trigger the function
Steps to reproduce
Follow the test scenario
** Description **
Description
I am trying service-binding example for lambda , installation goes fine but executing lambda function fails
kubeless function call redis-client -n stage
Fails with error
an error on the server ( "Internal Server Error") has prevented the request from succeeding ( get services redis-client:http-function-import)
I am trying this out on latest version of kyma deployed on gke
Description
In both examples:
The name of prometheus pod is invalid. The correct name for this pod is prometheus-monitoring
but in the examples we use prometheus-core
.
https://github.com/kyma-project/examples/blob/master/monitoring-alert-rules/README.md
Step number 2 is not working due to invalid name of the pod.
Now it is:
kubectl port-forward pod/prometheus-core-0 -n kyma-system 9090:9090
but it should be:
kubectl port-forward pod/prometheus-monitoring-0 -n kyma-system 9090:9090
https://github.com/kyma-project/examples/blob/master/monitoring-custom-metrics/README.md#access-the-exposed-metrics-in-prometheus
Now it is:
kubectl port-forward -n kyma-system svc/core-prometheus 9090:9090
but is should be:
kubectl port-forward -n kyma-system svc/monitoring-prometheus 9090:9090
The other things from this example works normally.
Description
For the purpose of the Getting Started guides, Wookiees created a new orders-service
example that consists of a simple microservice and function that use in-memory storage which can be switched to a Redis database.
After discussions with @a-thaler , it was decided that this new example should replace the currently existing http-db-service
example that works with MySQL instance.
To replace them:
orders-service
:
README.md
README.md
in exampleshttp-db-service
isn't used by any chance somewhere else, replace it with orders-service
, and then remove it completely.Description
Following the instructions provided on the readme - the build appears to be failing with the following results
../../../stretchr/testify/assert/assertions.go:1703:5: undefined: errors.Is
../../../stretchr/testify/assert/assertions.go:1726:6: undefined: errors.Is
../../../stretchr/testify/assert/assertions.go:1749:5: undefined: errors.As
../../../stretchr/testify/assert/assertions.go:1766:7: undefined: errors.Unwrap
../../../stretchr/testify/assert/assertions.go:1770:7: undefined: errors.Unwrap
The command '/bin/sh -c CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main .' returned a non-zero code: 2
Expected result
Build is successful
Actual result
Build fails which is preventing the ability to run the next step of running the docker image
Steps to reproduce
Troubleshooting
Confirm these statements before you submit the issue:
Ran the following commands
/build.sh
docker run -it --rm -p 8017:8017 http-db-service:latest
I can now access the docker image from http://127.0.0.1:8017
I can submit a POST and GET request on orders
Deployed to Kyma
export KYMA_EXAMPLE_ENV="qa"
kubectl apply -f deployment/deploymentOriginal.yaml -n $KYMA_EXAMPLE_ENV
Now I am not sure how to access this service. I only see internal IP address of the service - nothing external. Not sure what to use for host and port
curl --request GET --url http://:/orders
Description
Migrate call-ec example pipeline from Jenkins to Prow.
Migration guide is available here: https://github.com/kyma-project/test-infra/blob/master/docs/prow/migration-guide.md
Please, also update the table in this issue kyma-project/test-infra#118 after migration is done.
As a follow up of our monitoring tutorials (https://kyma-project.io/docs/components/monitoring/#tutorials-tutorials), I have updated an obsolete example. I did the following:
Description
Try to make the examples-chart of the examples repo available as bundle for the helm-broker/service catalog.
For that:
For testing:
Reasons
Via the helm-broker there is a nice way available of deploying services into a kyma installation without requiring any tooling. That will be a good alternative of testing and trying out the examples.
In consequence of making the examples testabale a generic hem chart got introduced supporting the installation of all examples into a kyma cluster. If that chart will be an official bundle, the alternative way of installation will be available out of the box, without modifying any example. As examples are very small, having one bundle for all examples instead of a bundle per example seems reasonable. It will not spoil the service catalog view so much. However, an example should be installable selectively by a parameter.
Description
The following function deployments cannot be edited in the UI - function editor is not visible.
https://github.com/kyma-project/examples/blob/master/service-binding/lambda/deployment/lambda-function.yaml
https://github.com/kyma-project/examples/blob/master/gateway/lambda/deployment.yaml
Expected result
UI editor displays the function body.
Troubleshooting
Just follow the tutorials for service-binding or gateway, navigate to lambda UI and open created functions.
Description
Example call-ec is not working. File expose-ec-function.yaml uses RouteRule that is no longer used in Kyma. Example should be reviewed and changed.
Furthermore it should be changed to use the mock framework https://github.com/kyma-incubator/varkes for application integration scenarios
Reason
Example is not working and may be confusing to the users.
Attachments
Link to example: https://github.com/kyma-project/examples/tree/master/call-ec
Description
Migrate monitoring-custom-metrics example pipeline from Jenkins to Prow.
Migration guide is available here: https://github.com/kyma-project/test-infra/blob/master/docs/prow/migration-guide.md
Please, also update the table in this issue kyma-project/test-infra#118 after migration is done.
Description
The tracing example (https://github.com/kyma-project/examples/tree/master/tracing) does not work.
The service is deployed, few curl
calls done, but in the jaeger console I could not sleect order-front.
Expected result
Jeager console allows me to select order-front and shows tracing info.
Hi,
Trying to follow the tutorial 'Develop a service locally without using Docker' on https://kyma-project.io/docs/#tutorials-tutorials.
First steps is building the application 'examples/http-db-service' locally using GO. Now I am quite new to GO but I think I followed the steps correctly.
After applying the first 2 steps I am in the right subfolder and all the github packages are installed under go/src
Still I am getting a build error when executing:
CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o main .
package .
main.go:14:2: use of internal package github.com/kyma-project/examples/http-db-service/internal/repository not allowed
Using go version go1.15.3 linux/amd64
Description
Add the end-to-end personservice
example (created by Andreas Krause) to the examples
repo. Divide the docs (preferably by components), proofread them, add conclusions from the investigation made as part of the this issue.
Expose the example in the main README.md
document of the kyma
repository.
Reasons
To have an end-to-end scenario in the kyma organization.
Attachments
Link to the example: https://github.com/kyma-incubator/examples/tree/master/personservice
Description
Currently the examples have local tests which are assuring that they work isolated.
We need tests assuring that they will work when applied to a Kyma cluster. Especially examples consisting only of yaml files needs to be tested against a Kyma cluster.
AC
Tests running on Kyma cluster using Prow
Confirm these statements before you submit the issue:
Description
The overview of all examples with title,description, technology is available as table in the README.md.
We want to enable a nice overview as part of the product documentation, for that we need a way to integrate the examples overview table.
Acceptance Criteria
Comment
An idea is to simply transform the table in the readme to HTML and it is still going to display nice as here: https://github.com/derberg/examples/blob/derberg-patch-1/README.md and in the UI we will always parse realtime the master version https://raw.githubusercontent.com/derberg/examples/derberg-patch-1/README.md and we will be able to transform the data into HTML and easily extract the table from it reliable way. It was verified by triggering the following code in the browser's console:
var xhr = new XMLHttpRequest();
--
xhr.addEventListener("load", transferComplete)
xhr.open("GET", "https://raw.githubusercontent.com/derberg/examples/derberg-patch-1/README.md");
xhr.send();
function transferComplete(event){
html = new DOMParser().parseFromString(event.currentTarget.response, "text/html");
table = html.getElementsByTagName('table');
console.log(table[0].innerHTML)
}
Description
Migrate tracing example pipeline from Jenkins to Prow.
Migration guide is available here: https://github.com/kyma-project/test-infra/blob/master/docs/prow/migration-guide.md
Please, also update the table in this issue kyma-project/test-infra#118 after migration is done.
A violation against the OSS Rules of Play has been detected.
Rule ID: rl-reuse_tool-2
Explanation: Does it have LICENSES directory with licenses? No
Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html
Description
Applications integrating with Kyma must interact with the Application Connector API to generate certificates and register APIs. Although the Application Connector API is stable and documented, it requires users to write boilerplate code and get familiar with (sometimes) technical APIs of the respective programming languages. These constraints and efforts are seen as inhibitors to Kyma adoption.
Although we are part of a polyglot environment the majority of modern business applications are written in:
Reasons
Providing simple to use convenience libraries (examples) for developers on these platforms would speed up the understanding and initial efforts of integrating with Kyma. An example of such a convenience library is: https://github.com/akrausesap/connector/tree/master/scpxf-connector
Description
Acceptance tests Pod for http-db-service fluctuates between Running
and CrashLoopBackOff
states.
Expected result
Pod should be in Completed
state once the tests are finished.
Steps to reproduce
Description
The example has some inconsistencies which should be fixed:
Reasons
Consistency across all examples to increase developer experience
Description
Some CRDs were updated as part of remote environment enhancement (Issue 914) . Currently the examples reference the old CRDs for EventActivation and Subscription CRDs and that needs to be fixed.
Expected result
Examples reference and use latest CRDs as defined here
Actual result
Examples are using outdated CRDs.
A violation against the OSS Rules of Play has been detected.
Rule ID: rl-security_policy-1
Explanation: Does it have a security policy? No
Find more information at: https://sap.github.io/fosstars-rating-core/oss_rules_of_play_rating.html
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.