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 pre-requsites to include checking docker is installed #6121

Merged

Conversation

pavanstarmanwar
Copy link
Contributor

@pavanstarmanwar pavanstarmanwar commented Feb 8, 2023

Changes

  • Add a line to check Docker is running
$ kind create cluster
ERROR: failed to create cluster: failed to list nodes: command "docker ps -a --filter label=io.x-k8s.kind.cluster=kind --format '{{.Names}}'" failed with error: exit status 1
Command Output: Cannot connect to the Docker daemon at unix:///Users/USER/.docker/run/docker.sock. Is the docker daemon running?
Ms-MacBook-Pro:~$ docker ps
Cannot connect to the Docker daemon at unix:///Users/USER/.docker/run/docker.sock. Is the docker daemon running?

After starting docker

Ms-MacBook-Pro:~$ kind create cluster
Creating cluster "kind" ...
 ✓ Ensuring node image (kindest/node:v1.25.3) 🖼 
 ✓ Preparing nodes 📦  
 ✓ Writing configuration 📜 
 ✓ Starting control-plane 🕹️ 
 ✓ Installing CNI 🔌 
 ✓ Installing StorageClass 💾 
Set kubectl context to "kind-kind"
You can now use your cluster with:

kubectl cluster-info --context kind-kind

Have a question, bug, or feature request? Let us know! https://kind.sigs.k8s.io/#community 🙂

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Feb 8, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Feb 8, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: pavanstarmanwar / name: pavan (1996546)

@tekton-robot tekton-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 8, 2023
@tekton-robot
Copy link
Collaborator

Hi @pavanstarmanwar. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

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

@pavanstarmanwar welcome to tekton!
/meow
/kind documentation
/ok-to-test

@tekton-robot tekton-robot added kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. labels Feb 8, 2023
@tekton-robot
Copy link
Collaborator

@jerop: cat image

In response to this:

@pavanstarmanwar welcome to tekton!
/meow
/kind documentation
/ok-to-test

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tekton-robot tekton-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 8, 2023
@pavanstarmanwar
Copy link
Contributor Author

/assign @pritidesai

docs/install.md Outdated Show resolved Hide resolved
@pritidesai
Copy link
Member

thank you @pavanstarmanwar for your contribution! Welcome to the tekton community 🎉

Please submit the checklist in the PR description. The additional check looks good to me.

I would suggest (a followup PR) to include an additional section troubleshooting in the end of the install.md to include what you have in the PR description i.e. before/after. Thanks!

@pritidesai pritidesai mentioned this pull request Feb 8, 2023
8 tasks
pavanstarmanwar added a commit to pavanstarmanwar/pipeline that referenced this pull request Feb 9, 2023
@tekton-robot tekton-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 9, 2023
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 14, 2023
@pritidesai
Copy link
Member

thank you @pavanstarmanwar 👍

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 14, 2023
@tekton-robot tekton-robot merged commit 2e1e168 into tektoncd:main Feb 14, 2023
@@ -22,6 +22,7 @@ This guide explains how to install Tekton Pipelines.
## Prerequisites

- A [Kubernetes cluster][k8s] running version 1.23 or later.
- If you are running on `macOS`, make sure Docker is running
Copy link
Member

Choose a reason for hiding this comment

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

Why only when running macOS? Why Docker?
This is a list of prerequisites for installing Tekton on Kubernetes - the first in the list is a Kubernetes cluster - the procedure is not really specific to where that kubernetes cluster is running.

@afrittoli
Copy link
Member

Thank you @pavanstarmanwar for your contribution!

The old installation guide was referring to kind specifically, but not the current one.
In the current guide, the installation instructions start after a couple of paragraphs about setting up a local cluster (https://tekton.dev/docs/installation/local-installation/) which refer to the kind and minikube documentation directly.

The starting point for this document is a running k8s cluster, so I don't think that docker and troubleshooting about kind do not belong in it.

FYI @geriom @pritidesai

I would propose to revert this PR.

@geriom
Copy link
Contributor

geriom commented Feb 16, 2023

The starting point for this document is a running k8s cluster, so I don't think that docker and troubleshooting about kind do not belong in it.

I would propose to revert this PR.

I agree with you. This information is specifically about kind and should be covered by the Kind documentation.

I'm reverting the changes in #6172 which also adds a bunch of missing links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesnt merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants