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

Fix auto-provisioned GitHub repo description after guided init #2708

Merged
merged 2 commits into from
Sep 9, 2024

Conversation

marcelovilla
Copy link
Member

Reference Issues or PRs

Closes #2636

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

How to test this PR?

  1. Run nebari init --guided-init
  2. Answer the prompts similarly to the following example:
Welcome to the Guided Init wizard!

You will be asked a few questions to generate your nebari-config.yaml. For more
details, refer to the Nebari docs:

        https://nebari.dev/docs/



 🪴  Nebari runs on a Kubernetes cluster: Where do you want this Kubernetes
cluster deployed? is where you want this Kubernetes cluster deployed. For more
details, refer to the Nebari docs:

        https://nebari.dev/docs/get-started/deploy


        ❗️ local requires Docker and Kubernetes running on your local machine.
Currently only available on Linux OS.
        ❗️ existing refers to an existing Kubernetes cluster that Nebari can be
deployed on.

        ❗️ Digital Ocean is currently being deprecated and support will be
removed in the future.

   Where would you like to deploy your Nebari cluster? Google Cloud Platform

 🪴  Nebari clusters that run in the cloud require specifying which region to
deploy to, please review the the cloud provider docs on the names and format
these region take For more details, refer to the gcp docs:

        https://cloud.google.com/compute/docs/regions-zones


   In which region would you like to deploy your Nebari cluster?
Defaulting to region:`us-central1`.

 🪴  Next, give your Nebari instance a project name. This name is what your
Kubernetes cluster will be referred to as.

        The project name must adhere to the following requirements:
        - Letters from A to Z (upper and lower case), numbers, hyphens, and
dashes
        - Length from 3 to 16 characters
        - Begin and end with a letter


   What project name would you like to use? bamboo


 🪴  Great! Now you can provide a valid domain name (i.e. the URL) to access
your Nebari instance. This should be a domain that you own. Default if
unspecified is the IP of the load balancer.


   What domain name would you like to use? bamboo.nebari.dev


 🪴  Nebari comes with Keycloak, an open-source identity and access management
tool. This is how users and permissions are managed on the platform. To connect
Keycloak with an identity provider, you can select one now.


        ❗️ password is the default option and is not connected to any external
identity provider.

   What authentication provider would you like? password


 🪴  This next section is optional but recommended. If you wish to adopt a
GitOps approach to managing this platform, we will walk you through a set of
questions to get that setup. With this setup, Nebari will use GitHub Actions
workflows (or GitLab equivalent) to automatically handle the future deployments
of your infrastructure.


   Would you like to adopt a GitOps approach to managing Nebari? Yes
   Which git provider would you like to use? github.com
   Which user or organization will this repository live under? (https://github.c
om/<org-name>/) marcelovilla
   And what will the name of this repository be? (https://github.com/marcelovill
a/<repo-name>) bamboo
   Would you like nebari to create a remote repository on github.com? Yes
Paste your GITHUB_USERNAME:
Paste your GITHUB_TOKEN:


 🪴  This next section is optional but recommended. If you want your Nebari
domain to use a Let's Encrypt SSL certificate, all we need is an email address
from you.


   Would you like to add a Let's Encrypt SSL certificate to your domain? No


 🪴  This next section is optional and includes advanced configuration changes
to the Terraform state, Kubernetes Namespace and Kubernetes version.
 ⚠️  caution is advised!


   Would you like to make advanced configuration changes? No
  1. Go to GitHub and check the repo description.

Here's an example of how it should look like (check the issue to see how it was being rendered before):

image

Any other comments?

@marcelovilla marcelovilla added this to the Next Release milestone Sep 5, 2024
@marcelovilla marcelovilla merged commit f61af76 into develop Sep 9, 2024
28 checks passed
@marcelovilla marcelovilla deleted the fix-gh-repo-description branch September 9, 2024 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done 💪🏾
2 participants