Giter Club home page Giter Club logo

jx-docs's Introduction

中文 Gitpod ready-to-code

Jenkins X Docs

This repository contains the source files for jenkins-x.io

NOTE: Please browse these docs on jenkins-x.io. Not all links work when browsing the Markdown files inside this repository.



Building the docs

Preparing the sources

To edit the docs locally, you need to clone this repository:

git clone  --recurse-submodules --depth 1 https://github.com/jenkins-x/jx-docs.git

Git submodules

Notice the use of --recurse-submodules in the clone command above. This option will pull in two git submodules, namely
docsy and labs-enhancements.

If you already have a git clone without the submodules checked out you can run:

git submodule update --init --recursive

In subsequent updates of the sources via git pull also remember to pull the changes from the submodules:

git pull --recurse-submodules

you can view the commit sha of the sub-modules via:

git submodule status --recursive

Downloading npm modules

After getting all the sources, you need to install npm and make sure the required npm modules are installed:

npm install

Running Hugo

The site itself is built with Hugo and configured in config.toml. You have two options to run Hugo, either directly on your machine or via Docker Compose. The following two sections describe the two alternatives in more detail.

NOTE: Hugo renders the site in memory in development mode. Per default, no content is written to disk.

Locally

If you want to build the site locally on your machine, you need to install Hugo. Check the Makefile for the latest recommended version use and check whether the environment variables of Golang are set. Set the env variable HUGO_GH_ACCESS_TOKEN to a github token that can read from jenkins-x/jx repo to allow the contributors plugin to run.

Once installed, you can run:

make server

You can now access the site under localhost:1313.

Dockerized

Instead of installing Hugo locally, you can use the provided docker-compose.yml to spin up the Hugo server in a containerized environment. Make sure you have Docker installed.

make compose-up

You can now access the site under localhost:1313. The Hugo server is running in the background. You can stop it via:

make compose-down

Common Workflows

Running spell check

We are not all masters of spelling, so luckily there are tools to help us fix that. We are using node-markdown-spellcheck to run through all our markdown files and list any spelling issue or unknown word.

To make this as simple as possible, just run the following command:

make spellcheck

The report likely includes words that are spelt correctly, but that just means the spell checker is not aware of the correct spelling (happens a lot for technical terms, commands, etc.). Please edit .spelling and add the unknown word. Also, please try and keep the list alphabetically sorted, which makes it easier to navigate.

Checking links, images, etc

To get help in checking all the links, we'll use htmlproofer.

make linkcheck

NOTE: The initial run is really slow (due to external link checks) and that the cache is only build up when it finishes.

NOTE:: It's safe to ignore the ... x509: certificate ... errors for now

Adding redirects

If you move a page to a different location you can add a redirect via using an aliases entry in the header of the page:

aliases:
  - /some/old/path
  - /another/path

Upgrading the enhancements content

To upgrade to a new enhancements commit - we'll hopefully automate this soon!

cd content/en/docs/labs/enhancements
git checkout master
git pull
cd ..
git add enhancements
git commit -m "move to latest enhancements"

Upgrading docsy

Docsy is added to the jx-docs repository as a submodule under the themes directory. To update docsy, run the following commands:

cd themes/docsy
git pull origin master
git submodule update --init --recursive

Localization

To let more people know Jenkins X better, localization is essential and meaningful. And we should keep some rules about this, please read related languages below:

Contributing

Please refer to the documentation contributing guide available at Jenkins X website.

jx-docs's People

Contributors

abayer avatar ankitm123 avatar ascheman avatar babadofar avatar cagiti avatar carlossg avatar dennisnewel avatar dependabot-preview[bot] avatar dependabot-support avatar donhui avatar ethangj avatar garethjevans avatar hferentschik avatar jenkins-x-bot avatar jenkins-x-bot-test avatar jha-cloudbees avatar jstrachan avatar linuxsuren avatar marckk avatar michaelneale avatar mmorejon avatar msvticket avatar osamamagdy avatar pmuir avatar pow-devops2020 avatar rajatgupta24 avatar rajdavies avatar rawlingsj avatar tgelpi avatar vbehar avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jx-docs's Issues

Cleanup of jx-docs branches

It seems like there are a ton of branches in this repo created by updatebot that could be automatically cleaned-up at some point.

Documentation about devpod / sync outdated?

The documentation about devpods and sync seems to be outdated, e.g.,

Feature Request: Cover "Parts of Jenkins-x"

I would like to see a portion of the docs that breaks down the structure of Jenkins X. I wish I could provide a bulleted list of these, but unfortunately, I don't know them yet. The idea came from the fantastic new video by @sharepointoscar on custom builders. I realized that I wasn't aware of the actual role of a builder. So, I'd like to see terms like builders, pipelines, apps, applications, Prow, etc. and how they interact with each other and with your project.

Improvements for Minikube steps: getting started

I'm looking to work on Jenkins X so the second thing I want to do is install it locally using Minikube (the first thing being to sub to mailing lists, get on the Slack channels, and to build/run jx from source).

Few improvements I'd like to make:

  • Provide known good configs (so I plan to contribute a docs update mentioning the values I used)
  • A verbose flag for cluster creation
  • Basic troubleshooting for when things don't go to plan!
  • Improved error messages; seeing this atm Error: Command failed minikube start --memory 8192 --cpus 8 --disk-size 150GB --vm-driver hyperkit --bootstrapper=kubeadm error creating cluster exit status 1

Not sure if this is the right place to create issues really (used to using JIRA for previous open source projects I've worked on), so creating it here so folks know I'm on the case - currently create minikube cluster hangs, and minikube logs isn't particularly helpful.

I'm going off existing docs here.

Command JX create user/jenkins user/jenkins token is confusing

JX create user documentation looks confusing.

Need a little bit more explanation what exactly jenkins user is from cli perspective. It's not the same as user in jenkins definitely. "Create a new User which is then provisioned by the user controller" explains almost nothing.

This one is confusing too
https://github.com/jenkins-x/jx-docs/blob/master/content/commands/jx_create_jenkins_user.md
And it's not working because the actual command is

╰─ jx create jenkins token -p somePassword someUserName
Please go to http://jenkins.jx.sn00p.silenkov.biz/me/configure and click Show API Token to get your API Token
Then COPY the token and enter in into the form below:

? API Token:

Help from this cli command is confusing too because you can't click Show API Token in recent jenkins version. You could only add a new token to the preexisting user, called admin in our case.

So there is no way to add new user in jenkins via CLI, only via admin UI. It should be stated in documentation as there is a high demand operation to add not only tokens but users in jenkins installation.

Thanks,

Recommendations for improving "Getting Started"

Summary

The approach for “Getting Started” in the docs is cumbersome. There’s so much information in the critical path as you navigate — it’s easy to lose your way. It’s all good information, but over time it seems to have lost its cohesiveness. The intent of this issue is to start a conversation about how to improve the new-user experience.

General critiques and recommendations

Up front, including a “getting started” or “start here” main menu item in the header on the main JX landing page would be a good callout. Not everyone considers the “Documentation” to be a good place to start (and many times that’s true).

From there, it’s reasonable to consider the personas that would be clicking that link:

  • A developer wants to try Jenkins X for the first time to get a sample application quickly running.
  • A devops engineer wants to see how Jenkins X can improve delivery.
  • What others??

Some other noted issues on the current Getting Started Page:

  • A developer should easily be able to find the critical path to getting a specific type of app created in a new cluster. Needs to get to use cases more quickly.
  • A bit crowded with a lot of advanced features and other capabilities that might confuse a newcomer. E.g. “Multiple Clusters”, “Create custom Builder”, “Configuration”, and “Manage by GitOps” are all important topics, but probably do not need to be highlighted on a Getting Started page.
  • Don't make a big deal initially of the install command, reference in a parenthetical. Or, at least explain why you would choose one over the other, with a big preference for creating a cluster for your first try.
  • There’s also a “Getting Started”-titled page under the “Developing” section that could be easily conflated; it’s just a bit confusing.
  • Make it obvious what to do if things break. Especially instructions on how to completely remove what was created. Load balancers, and PVs can be left behind and accruing charges.

Proposed Flow

Getting Started

How to get a new application running with Jenkins X:

  1. get jx (and other pre-reqs)
  2. jx create cluster (or jx install)
    • Talk about interactive options (take into account potential --advanced flag?)
  3. jx create quickstart (node-specific)
    • Tell which options to pick and why those important
    • Explain where things can fail and why, and where to get help
  4. Show how to verify that things were successful
  5. Show how to view the resulting application’s url

It feels like this should be a ONE PAGE tutorial, and you could swap in whatever quickstart you wanted. You’ll also note that we did not discuss any advanced topics about gitops or kubernetes. With the happy path, this isn’t actually needed.

What’s next

Once the “getting started” is done, and an application is successfully deployed to staging, “What’s next” is definitely on the person’s mind. I think this is where we can have a list of specific next actions to take. This list should be things that can immediately do.

  • Next set actions in a typical workflow
    • Promote to production environment
    • Make a change, create a PR, and see the creation of the preview environment
  • Use devpods
  • Import existing application
  • Add an existing helm chart to an environment

Intermediate/Advanced

Anything else that requires a different jx installation approach, or modification to the default jx install would be in a separate guide and should be considered intermediate and advanced topics. This list isn’t meant to be exhaustive of the current docs, just examples.

  • How to upgrade jx components
  • Multiple Clusters
  • Changing configuration of a running cluster, or advanced flags for installation

Conclusion

This recommendation is neither final nor complete; it’s just the start! We’re filing this as an issue before actually putting work into this so we can gather the critiques and recommendations of the community up front.

Thanks!

@kyounger & @drwarner

Wrong tone of PR review guidelines

I find the tone of the current pull request review guidelines not quite suited for the community. It does not sounds welcoming and encouraging.

There might be a need to differentiate between internal maintainer guidelines and external communication.

Also the focus on Slack and 1-on-1 calls over written communication (see jenkins-x/jx#5027) is not OSS friendly.

Getting onto Slack or even 1-on-1 call is a big hurdle for potential contributors, especially new ones.

better jx command reference page

the new website is lovely; but I wonder if we could improve the first page of the command reference....
https://jenkins-x.io/docs/reference/commands/

its quite a big list of commands. Ideally we'd have a little smart completing search box or something. Mind you at least you can do the browser control-F key press and search the page for a command you want ;)

One thing we added to jx help was a way to group commands into sections - I wonder if we can try something like that? Mind you this may involve hacking the cobra code generation code used in the jx create docs command: https://jenkins-x.io/commands/jx_create_docs/

e.g. here's the output of jx help:

jx is a command line tool for working with Jenkins X

Installing:
  profile          Set your jx profile
  boot             Boots up Jenkins X in a Kubernetes cluster using GitOps and a Jenkins X Pipeline
  install          Install Jenkins X in the current Kubernetes cluster
  uninstall        Uninstall the Jenkins X platform
  upgrade          Upgrades a resource
  create cluster   Create a new Kubernetes cluster
  update cluster   Updates an existing Kubernetes cluster
  create jenkins token Adds a new username and API token for a Jenkins server
  delete jenkins token Deletes one or more Jenkins user API tokens
  init             Init Jenkins X

Adding Projects to Jenkins X:
  import           Imports a local project or Git repository into Jenkins
  create archetype Create a new app from a Maven Archetype and import the generated code into Git and Jenkins for CI/CD
  create spring    Create a new Spring Boot application and import the generated code into Git and Jenkins for CI/CD
  create lile      Create a new Lile based application and import the generated code into Git and Jenkins for CI/CD
  create micro     Create a new micro based application and import the generated code into Git and Jenkins for CI/CD
  create quickstart Create a new app from a Quickstart and import the generated code into Git and Jenkins for CI/CD
  create quickstartlocation Create a location of quickstarts for your team

Apps:
  create addon     Creates an addon
  create token addon Adds a new token/login for a user for a given addon
  delete addon     Deletes one or more addons
  delete token addon Deletes one or more API tokens for a user on an issue addon server
  delete app       Deletes one or more apps from Jenkins X
  delete application Deletes one or more applications from Jenkins
  add app          Adds an app

Git:
  create git server Creates a new Git server from a URL and kind
  delete git server Deletes one or more Git servers
  create git token Adds a new API token for a user on a Git server
  delete git token Deletes one or more API tokens for a user on a Git server
  repository       Opens the web page for the current Git repository in a browser

Working with Kubernetes:
  compliance       Run compliance tests against Kubernetes cluster
  completion       Output shell completion code for the given shell (bash or zsh)
  context          View or change the current Kubernetes context (Kubernetes cluster)
  environment      View or change the current environment in the current Kubernetes cluster
  team             View or change the current team in the current Kubernetes cluster
  namespace        View or change the current namespace context in the current Kubernetes cluster
  prompt           Generate the command line prompt for the current team and environment
  scan             Perform a scan action
  shell            Create a sub shell so that changes to the Kubernetes context, namespace or environment remain local to the shell
  status           status of the Kubernetes cluster or named node

Working with Applications:
  console          Opens the Jenkins console
  logs             Tails the log of the latest pod for a deployment
  open             Open a service in a browser
  rsh              Opens a terminal in a pod or runs a command in the pod
  sync             Synchronises your local files to a DevPod

Working with CloudBees application:
  cloudbees        Opens the CloudBees app for Kubernetes for visualising CI/CD and your environments
  login            Onboard an user into the CloudBees application

Working with Environments:
  preview          Creates or updates a Preview Environment for the current version of an application
  promote          Promotes a version of an application to an Environment
  create addon environment Create an Environment Controller to handle webhooks and promote changes from GitOps
  create environment Create a new Environment which is used to promote your Team's Applications via Continuous Delivery
  delete addon environment Deletes the Environment Controller
  delete environment Deletes one or more Environments
  edit environment Edits an Environment which is used to promote your Team's Applications via Continuous Delivery
  get environments Display one or more Environments

Working with Jenkins X resources:
  get              Display one or more resources
  edit             Edit a resource
  create           Create a new resource
  update           Updates an existing resource
  delete           Deletes one or more resources
  add              Adds a new resource
  start            Starts a process such as a pipeline
  stop             Stops a process such as a pipeline

Jenkins X Pipeline Commands:
  step             pipeline steps

Jenkins X services:
  controller       Runs a controller
  gc               Garbage collects Jenkins X resources

Other Commands:
  diagnose         Print diagnostic information about the Jenkins X installation
  docs             Open the documentation in a browser
  help             Help about any command
  version          Print the version information

Locally Available Commands:
  release version  /Users/jstrachan/bin/jx-release-version (from plugin)

Options:
  -b, --batch-mode=false: Runs in batch mode without prompting for user input
      --verbose=false: Enables verbose output
Usage:
  jx [flags] [options]
Use "jx <command> --help" for more information about a given command.
Use "jx options" for a list of global command-line options (applies to all commands).

I suggest create a localization team for jx-docs

As the title says. If we have such a team, anyone creates a new page or modify something, he can notify the team's members, then we can keep the docs in sync between multi-languages.
And I think it will be helpful if we want more and more people to begin to accept 'jx' and use it in a production environment.
@jstrachan

jx install error during registry tokens during install in IKS

When using jx install with IKS provider I get an error

    "code": "CRT0002E",
    "message": "The creation of registry tokens is discontinued. For more information about how to use API keys to automate access to your namespaces, see: https://cloud.ibm.com/docs/services/Registry?topic=registry-registry_access",
    "request-id": "f929a09df5f092faf5794d178da7f2ea"
}
error: configuring the docker registry: configure cloud provider docker registry: getting IKS registry configuration: Request failed with status code: 410, ServerErrorResponse: {
    "code": "CRT0002E",
    "message": "The creation of registry tokens is discontinued. For more information about how to use API keys to automate access to your namespaces, see: https://cloud.ibm.com/docs/services/Registry?topic=registry-registry_access",
    "request-id": "f929a09df5f092faf5794d178da7f2ea"

jx --version:
2.0.474

Jenkins X install instructions need to cover the fact that repositories are created private

Changes to the docs are needed due to the fact that repositories are not created private per default - see jenkins-x/jx#5186

The docs should include something along these lines:

Jenkins X creates repositories per default as private. This can cause issues when evaluating Jenkins X with GitHub using a free GitHub organisation to hold the various created (environment) repositories. For evaluation purposes you can use a GitHub user as owner of the repositories. Alternatively, you can enable public environment repositories by specifying the --git-public option as part of jx create or jx install"

Needs to mention also environmentGitPublic in the case of jx boot.

Might need to get into a bit more detail for the using GitHub user case. Maybe its worth explicitly mentioning that GitHub allows free users to create private repositories, but not free organization (free as in no paid subscription)

Open in Pycharm IDE does not work

io.fabric8.kubernetes.client.KubernetesClientException: Operation: [list] for kind: [CustomResourceDefinition] with name: [null] in namespace: [null] failed.
at io.fabric8.kubernetes.client.KubernetesClientException.launderThrowable(KubernetesClientException.java:62)
at io.fabric8.kubernetes.client.KubernetesClientException.launderThrowable(KubernetesClientException.java:71)
at io.fabric8.kubernetes.client.dsl.base.BaseOperation.list(BaseOperation.java:588)
at io.fabric8.kubernetes.client.dsl.base.BaseOperation.list(BaseOperation.java:49)
at io.jenkins.x.client.kube.ClientHelper.pipelineActivityClient(ClientHelper.java:21)
at io.jenkins.x.client.PipelineClient.newInstance(PipelineClient.java:69)
at io.jenkins.x.client.PipelineClient.newInstance(PipelineClient.java:65)
at io.jenkins.x.client.tree.PipelineTreeModel.newInstance(PipelineTreeModel.java:44)
at io.jenkins.x.idea.plugin.JenkinsXToolWindowFactory.createToolWindowContent(JenkinsXToolWindowFactory.java:57)
at com.intellij.openapi.wm.impl.ToolWindowImpl.ensureContentInitialized(ToolWindowImpl.java:533)
at com.intellij.openapi.wm.impl.ToolWindowImpl.getContentManager(ToolWindowImpl.java:356)
at com.intellij.openapi.wm.impl.content.ContentTabLabel.contentManager(ContentTabLabel.java:355)
at com.intellij.openapi.wm.impl.content.ContentTabLabel.isSelected(ContentTabLabel.java:338)
at com.intellij.openapi.wm.impl.content.ContentTabLabel._getGraphics(ContentTabLabel.java:347)
at com.intellij.openapi.wm.impl.content.BaseLabel.paintComponent(BaseLabel.java:84)
at com.intellij.openapi.wm.impl.content.ContentTabLabel.paintComponent(ContentTabLabel.java:333)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at com.intellij.openapi.wm.impl.content.ToolWindowContentUi.paintChildren(ToolWindowContentUi.java:255)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at com.intellij.openapi.wm.impl.ToolWindowHeader.paintChildren(ToolWindowHeader.java:305)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JLayeredPane.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JLayeredPane.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintChildren(Unknown Source)
at java.desktop/javax.swing.JComponent.paint(Unknown Source)
at java.desktop/javax.swing.JComponent.paintToOffscreen(Unknown Source)
at java.desktop/javax.swing.RepaintManager$PaintManager.paintDoubleBufferedImpl(Unknown Source)
at java.desktop/javax.swing.RepaintManager$PaintManager.paintDoubleBuffered(Unknown Source)
at java.desktop/javax.swing.RepaintManager$PaintManager.paint(Unknown Source)
at java.desktop/javax.swing.RepaintManager.paint(Unknown Source)
at java.desktop/javax.swing.JComponent._paintImmediately(Unknown Source)
at java.desktop/javax.swing.JComponent.paintImmediately(Unknown Source)
at java.desktop/javax.swing.RepaintManager$4.run(Unknown Source)
at java.desktop/javax.swing.RepaintManager$4.run(Unknown Source)
at java.base/java.security.AccessController.doPrivileged(Native Method)
at java.base/java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(Unknown Source)
at java.desktop/javax.swing.RepaintManager.paintDirtyRegions(Unknown Source)
at java.desktop/javax.swing.RepaintManager.paintDirtyRegions(Unknown Source)
at java.desktop/javax.swing.RepaintManager.prePaintDirtyRegions(Unknown Source)
at java.desktop/javax.swing.RepaintManager$ProcessingRunnable.run(Unknown Source)
at java.desktop/java.awt.event.InvocationEvent.dispatch(Unknown Source)
at java.desktop/java.awt.EventQueue.dispatchEventImpl(Unknown Source)
at java.desktop/java.awt.EventQueue$4.run(Unknown Source)
at java.desktop/java.awt.EventQueue$4.run(Unknown Source)
at java.base/java.security.AccessController.doPrivileged(Native Method)
at java.base/java.security.ProtectionDomain$JavaSecurityAccessImpl.doIntersectionPrivilege(Unknown Source)
at java.desktop/java.awt.EventQueue.dispatchEvent(Unknown Source)
at com.intellij.ide.IdeEventQueue.defaultDispatchEvent(IdeEventQueue.java:742)
at com.intellij.ide.IdeEventQueue._dispatchEvent(IdeEventQueue.java:691)
at com.intellij.ide.IdeEventQueue.dispatchEvent(IdeEventQueue.java:386)
at java.desktop/java.awt.EventDispatchThread.pumpOneEventForFilters(Unknown Source)
at java.desktop/java.awt.EventDispatchThread.pumpEventsForFilter(Unknown Source)
at java.desktop/java.awt.EventDispatchThread.pumpEventsForHierarchy(Unknown Source)
at java.desktop/java.awt.EventDispatchThread.pumpEvents(Unknown Source)
at java.desktop/java.awt.EventDispatchThread.pumpEvents(Unknown Source)
at java.desktop/java.awt.EventDispatchThread.run(Unknown Source)
Caused by: java.net.UnknownHostException: No such host is known (kubernetes.default.svc)
at java.base/java.net.Inet4AddressImpl.lookupAllHostAddr(Native Method)
at java.base/java.net.InetAddress$PlatformNameService.lookupAllHostAddr(Unknown Source)
at java.base/java.net.InetAddress.getAddressesFromNameService(Unknown Source)
at java.base/java.net.InetAddress$NameServiceAddresses.get(Unknown Source)
at java.base/java.net.InetAddress.getAllByName0(Unknown Source)
at java.base/java.net.InetAddress.getAllByName(Unknown Source)
at java.base/java.net.InetAddress.getAllByName(Unknown Source)
at okhttp3.Dns$1.lookup(Dns.java:40)
at okhttp3.internal.connection.RouteSelector.resetNextInetSocketAddress(RouteSelector.java:185)
at okhttp3.internal.connection.RouteSelector.nextProxy(RouteSelector.java:149)
at okhttp3.internal.connection.RouteSelector.next(RouteSelector.java:84)
at okhttp3.internal.connection.StreamAllocation.findConnection(StreamAllocation.java:213)
at okhttp3.internal.connection.StreamAllocation.findHealthyConnection(StreamAllocation.java:134)
at okhttp3.internal.connection.StreamAllocation.newStream(StreamAllocation.java:113)
at okhttp3.internal.connection.ConnectInterceptor.intercept(ConnectInterceptor.java:42)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
at okhttp3.internal.cache.CacheInterceptor.intercept(CacheInterceptor.java:93)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
at okhttp3.internal.http.BridgeInterceptor.intercept(BridgeInterceptor.java:93)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
at okhttp3.internal.http.RetryAndFollowUpInterceptor.intercept(RetryAndFollowUpInterceptor.java:125)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
at io.fabric8.kubernetes.client.utils.ImpersonatorInterceptor.intercept(ImpersonatorInterceptor.java:56)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
at io.fabric8.kubernetes.client.utils.HttpClientUtils$2.intercept(HttpClientUtils.java:109)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:147)
at okhttp3.internal.http.RealInterceptorChain.proceed(RealInterceptorChain.java:121)
at okhttp3.RealCall.getResponseWithInterceptorChain(RealCall.java:200)
at okhttp3.RealCall.execute(RealCall.java:77)
at io.fabric8.kubernetes.client.dsl.base.OperationSupport.handleResponse(OperationSupport.java:379)
at io.fabric8.kubernetes.client.dsl.base.OperationSupport.handleResponse(OperationSupport.java:344)
at io.fabric8.kubernetes.client.dsl.base.OperationSupport.handleResponse(OperationSupport.java:328)
at io.fabric8.kubernetes.client.dsl.base.BaseOperation.list(BaseOperation.java:584)
... 69 more

should I create pv before run " jx install --provider=kubernetes --on-premise"

after I ran install-command-line,
jx install --provider=kubernetes --on-premise
I found that all pvc were pending


root@172-18-23-101:~/xxx# kubectl get pvc
NAME                        STATUS    VOLUME    CAPACITY   ACCESS MODES   STORAGECLASS   AGE
jenkins                     Pending                                                      4m
jenkins-x-chartmuseum       Pending                                                      4m
jenkins-x-docker-registry   Pending                                                      4m
jenkins-x-mongodb           Pending                                                      4m
jenkins-x-nexus             Pending                                                      4m
root@172-18-23-101:~/xxx# kubectl get pvc
NAME                        STATUS    VOLUME    CAPACITY   ACCESS MODES   STORAGECLASS   AGE
jenkins                     Pending                                                      4m
jenkins-x-chartmuseum       Pending                                                      4m
jenkins-x-docker-registry   Pending                                                      4m
jenkins-x-mongodb           Pending                                                      4m
jenkins-x-nexus             Pending                                                      4m

hugo redirects are no longer working - and old data is served

since the move from netlify to github pages the redirects are no longer working.

This alas means that there is some old content being serverd.

I tried a quick fix, but the Chinese documentation is using the same aliases without prefixing the URL with /zh/ and it is a case of last wins so the alias serves a Chinese page if one exists.

Improvements to Install on Kubernetes - what happens

A LOT is happening under the scene and this would really usefull for new comers to understand more (which CLI is installed, which pods are installed for JenkinsX...). This would also help potential contributors

I will work on this and propose a updated version of this page.

can not install IKS due to occur error for specified k8s version

imac:~ maho$ jx create cluster iks --apikey=XXXX -k 1.12.7
? Region us-south
? Cluster Name: jx2
? Zone (location): dal13
? Kubernetes Node Machine Type: b2c.4x16
? Number of kubernetes workers: 3
Creating Private VLAN.
Creating Public VLAN.
Creating cluster named jx2
ERROR: error creating cluster Request failed with status code: 503, ServerErrorResponse: ???
?@?????F??VEV?
??$.??c?? ?{ ?n9??
?U??s??f??? !*K?7/?kv?r???q̬2???"`??Ќ5ǻP}y?O??"!ה?_N?4`??{7?>_鮩?

jx install --provider=iks does not work at us other region

Hello,

jx install --provider=iks does not work US other region.
Please see error message part.

The specified cluster could not be found. Target a region. If you're using resource groups, make sure that you target the correct resource

this command can not find cluster name in US other region.

imac:~ maho$ bx ks region-get
Region: ap-north

imac:~ maho$ jx install --provider=iks --skip-ingress --external-ip=165.192..* --domain=iks1.jp-tok.containers.appdomain.cloud
? Select Jenkins installation type: Static Jenkins Server and Jenkinsfiles
Setting the dev namespace to: jx
Using helmBinary helm with feature flag: template-mode
Context "iks1" modified.
Enabling helm template mode in the TeamSettings
Git configured for user: Maho Takara and email [email protected]
Wait for Ingress controller to be injected into IBM Kubernetes Service Cluster
error: initializing the Jenkins X platform: initializing the Jenkins X platform: Request failed with status code: 404, ServerErrorResponse: {"incidentID":"2067f72b-7996-40cf-9c88-b1e5a37a24b6",ç If you're using resource groups, make sure that you target the correct resource group.","type":"Authentication","recoveryCLI":"To list the clusters you have access to, run 'ibmcloud ks clusters'. To check the resource group ID of the cluster, run 'ibmcloud ks cluster-get \u003ccluster_name_or_ID\u003e'. To list the resource groups that you have access, run 'ibmcloud resource groups'. To target the resource group, run 'ibmcloud target -g \u003cresource_group\u003e'. To target a region, run 'ibmcloud ks region-set'."}

FAQ issues -> Finding passwords for jenkins and core services merge and update

What are the credentials to access core services?
How do I get the Password and Username for Jenkins?

are basically the same question/answer. Also the current answer for core services is incorrect if use serverless pipelines (their passwords are in adminSecrets.yaml). I'm happy to PR a combine and clarify item but figured I should ask if this is worth doing first.

Dependabot couldn't find a package.json for this project

Dependabot couldn't find a package.json for this project.

Dependabot requires a package.json to evaluate your project's current JavaScript dependencies. It had expected to find one at the path: /themes/gohugoioTheme/src/package.json.

If this isn't a JavaScript project, or if it is a library, you may wish to disable updates for it from within Dependabot.

You can mention @dependabot in the comments below to contact the Dependabot team.

Generate auto-complete on demand

To complete a bit https://github.com/jenkins-x/jx-docs/blob/master/content/commands/jx_completion.md

On MacOs for auto-completion you can add something like this in your .bash_profile if you have installed bash-completion with brew

JX_BIN=`which jx`
JX_FILE=/usr/local/share/bash-completion/completions/jx
if [ "${JX_FILE}" -ot "${JX_BIN}" ]; then
  echo Regenerating ${JX_BIN} auto-completion
  "${JX_BIN}" completion bash > "$JX_FILE"
fi

It regenerates the autocompletion script only if jx is more recent than the file

Should be the similar for Linux.

Fix Nexus Link

The page install-on-cluster-what-happens.md links to the wrong "Nexus" product.

No IDE Extension/Plugin provides tracking of builds

Is there a special configuration to get the Jenkins X plugin working for an IDEA based IDE? I've seen the VSCODE plugin with an empty tree #35 and as a fan of Intellij I switched to that but get a similar problem where the Jenkins X tool window is empty.

image

Using a default ~/.kube/config file with multiple clusters configured.

  • are there common issues to step through why I could be having issues?
  • are the plugins still WIP?

Thanks!

Add JenkinsX roadmap page

When checking the Features page, there was a link at the bottom pointing to the Roadmap page. Unfortunately, this page does not currently exist. It would be great if we could create such a page for people to be able to get information on the roadmap of the project.

Fix MarkDown links

At least install-on-cluster-what-happens.md has some syntax inversions, breaking the links rendering.

Update codegen documention

After the latest changes to code generation in jx we need to update the section in the jx development section covering code generation.

Tutorial/Howto setup application with database

Write a tutorial or at least a short HowTo to setup an application with database with Jenkins X, e.g., as in https://medium.com/sitewards/deploying-on-kubernetes-1-the-use-case-b4c201e2f049.

Outline:

  • Create Spring Boot application with relevant modules (Spring data, JDBC, H2 for testing?)
  • Extend app with JPA adapter (Repository, Entities)
  • Add Database (PostgreSQL?) to deployment (Helm dependency)
  • Configure access to DB in Spring Boot (probably with ConfigMap/Secrets in k8s)
  • Promote to production

Optional:

  • Provide different configurations for staging and production
  • Provide Persistent Volume as data directory

inconsistent font usage

The front page uses one one set of fonts while the other pages uses another. we should standardize on the fonts used on the front page

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.