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

docs: content for KeptnTaskDefinition ref and tasks guide #1392

Merged
merged 35 commits into from
May 22, 2023
Merged

docs: content for KeptnTaskDefinition ref and tasks guide #1392

merged 35 commits into from
May 22, 2023

Conversation

StackScribe
Copy link
Contributor

  • Moves the info in the concepts/task page to the KeptnTaskDefinition ref page
    • Big sections about secrets and context are still on this page but I think each of them should be discussed on their own page in "Implementing" -- merge with info that is currently in the "Working with tasks" page
  • Deletes the concepts/task file
  • Moves the tasks/write-tasks file into integrating/task.md
    • Delete material that absolutely duplicates what is in the KeptnTaskDefinition ref page
    • Did a quick rewrite of what was left, basically "Parameterizing functions" and "Using secrets"
    • The KeptnTaskDefinition ref page also has some info about parameters and secrets. I think all the "secrets" information needs to be pulled into its own page in the "Implementing..." section

This PR supercedes , which supercededhttps://github.com//pull/1194, which superceded #1083, which also attempted to move the autogenerated files from the crd-ref directory to api-ref.

Satisfies #1078

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe added the documentation Improvements or additions to documentation label May 9, 2023
@StackScribe StackScribe self-assigned this May 9, 2023
@StackScribe StackScribe requested review from a team as code owners May 9, 2023 23:14
@netlify
Copy link

netlify bot commented May 9, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit da56752
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/646b2eaac06c220008768178
😎 Deploy Preview https://deploy-preview-1392--keptn-lifecycle-toolkit.netlify.app/docs/concepts/workloads
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
StackScribe and others added 6 commits May 16, 2023 06:45
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Copy link
Contributor Author

@StackScribe StackScribe left a comment

Choose a reason for hiding this comment

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

publish comments

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
…it into 0509-taskref

Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com
https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/custom-metrics-api.md

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
StackScribe and others added 10 commits May 22, 2023 01:30
https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/custom-metrics-api.md

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/custom-metrics-api.md

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/custom-metrics-api.md

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/custom-metrics-api.md

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/custom-metrics-api.md

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/custom-metrics-api.md

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
apiVersion: lifecycle.keptn.sh/v1alpha2
kind: KeptnTaskDefinition
metadata:
  name: scheduled-deployment
spec:
  function:
    configMapRef:
      name: scheduled-deployment-cm-1
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: scheduled-deployment-1
data:
  code: |
    let text = Deno.env.get("DATA");
    let data;
    if (text != "") {
        data = JSON.parse(text);
    }
    let targetDate = new Date(data.targetDate)
    let dateTime = new Date();
    if(targetDate < dateTime) {
        console.log("Date has passed - ok");
        Deno.exit(0);
    } else {
        console.log("It's too early - failing");
        Deno.exit(1);
    }
    console.log(targetDate);

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@sonarcloud
Copy link

sonarcloud bot commented May 22, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Contributor

@RealAnna RealAnna left a comment

Choose a reason for hiding this comment

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

LGTM!

@StackScribe StackScribe merged commit 13b0495 into keptn:main May 22, 2023
17 checks passed
@keptn-bot keptn-bot mentioned this pull request May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants