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: Update contributors-quickstart.md to include Docker instructions for Mac. #16861

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Laraib21
Copy link

Signed-off-by: Laraib Iqbal [email protected]

This change adds instructions for those who are trying to get set-up with ArgoCD on Mac and are using Docker Desktop. I was having trouble using Docker Desktop myself and so I deemed it important to add, so other Mac users don't waste time on the same issue.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

@Laraib21 Laraib21 requested review from a team as code owners January 14, 2024 19:42
Copy link

codecov bot commented Jan 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.30%. Comparing base (d9df252) to head (5911d11).
Report is 1205 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #16861   +/-   ##
=======================================
  Coverage   49.30%   49.30%           
=======================================
  Files         272      272           
  Lines       47985    47985           
=======================================
  Hits        23660    23660           
  Misses      21983    21983           
  Partials     2342     2342           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@blakepettersson blakepettersson left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@@ -25,6 +25,9 @@ git clone https://github.com/argoproj/argo-cd.git

<https://docs.docker.com/engine/install/>

#### Note for Mac users:
Copy link
Member

Choose a reason for hiding this comment

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

Are these instructions specific for Mac only? I'd imagine that this would need to be done for Linux as well?

Copy link
Member

Choose a reason for hiding this comment

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

@blakepettersson I believe it's Docker Desktop specific. So title should be changed to

#### Note for Docker Desktop users:

Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

These are really instructions for Docker Desktop, it should just be part of those instructions.

@todaywasawesome
Copy link
Contributor

@Laraib21 Looking at this PR again, it needs to be changed. There are two different instruction steps, one is to install docker, which is needed, and the 2nd is to setup some kind of local cluster. Instead of telling mac users to enable kubernetes on Docker desktop, lets make Docker desktop one of the setup options below where the kind cluster setup is listed. That would make more sense.

@Laraib21
Copy link
Author

Hi, before I make the commit with the changed instructions I wanted to post them here, first:

"""
To get started with ArgoCD, you'll need to have Docker installed and set up a local Kubernetes cluster. Below are the steps to set up Docker Desktop as one of the options for your Kubernetes cluster setup.

Step 1: Install Docker Desktop
Download and install Docker Desktop from the official Docker website.
Follow the installation instructions for your operating system.
Step 2: Set Up a Local Kubernetes Cluster
For setting up a local Kubernetes cluster, you have a few options. Here, we'll outline how to set up a cluster using Docker Desktop and another option using kind (Kubernetes in Docker). Choose the one that best fits your needs.

Option A: Using Docker Desktop
Open the Docker Desktop application.
Go to Settings (or Preferences on macOS).
Find the Kubernetes tab in the menu.
Enable Kubernetes by checking the "Enable Kubernetes" option.
Also, check the "Show system containers (advanced)" option for more detailed insights into your cluster.
Click Apply & Restart to apply the changes. Docker Desktop will now set up a Kubernetes cluster for you.
Option B: Using kind (Kubernetes in Docker)
If you prefer not to use Docker Desktop for Kubernetes or are looking for a more lightweight alternative, you can use kind. Here's how:

Ensure Docker is running on your machine.
Install kind following the instructions on their GitHub page.
Create a new cluster by running kind create cluster in your terminal.
Next Steps
Once you have Docker and your local Kubernetes cluster set up, you're ready to proceed with the installation and configuration of ArgoCD. Follow the next steps in the ArgoCD documentation to continue.
"""

Copy link
Member

@christianh814 christianh814 left a comment

Choose a reason for hiding this comment

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

I would change the title to be

#### Note for Docker Desktop users:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants