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.

Sign up for GitHub

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

Jump to bottom

Using different artifact repositories in a restricted environment #1160

Merged
merged 2 commits into from
Apr 8, 2020
Merged

Using different artifact repositories in a restricted environment #1160

merged 2 commits into from
Apr 8, 2020

Conversation

yhontyk
Copy link

@yhontyk yhontyk commented Mar 24, 2020 •
edited

What does this PR do?

  • Maven
  • Gradle
  • Python
  • Golang
  • C#

What issues does this PR fix or reference?

Specify the version of the product this PR applies to.

@yhontyk yhontyk changed the title [WIP] Using differen artifact repositories in restricted environment [WIP] Using different artifact repositories in restricted environment Mar 24, 2020
@yhontyk yhontyk changed the title [WIP] Using different artifact repositories in restricted environment [WIP] Using different artifact repositories in a restricted environment Mar 24, 2020
@yhontyk
Copy link
Author

yhontyk commented Mar 24, 2020

@tsmaeder could you review, when you have time?
It is based on your draft, just styled and broken down according to our styleguide. Feel free to tag anyone who can help with reviewing, adding info and so on, I know the docs are huge.

If you want to see the preview of how it will look on the website, checkout into this branch locally and run the run.sh script in the root of the directory. Let me know if there are any troubles with it.

tsmaeder
tsmaeder previously requested changes Mar 31, 2020
View reviewed changes
Copy link
Contributor

@tsmaeder tsmaeder left a comment

Choose a reason for hiding this comment

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

It is very hard to ascertain completeness of the doc in this form because it's so atomized. Maybe it's better to do reviews in long form and then convert it into the technically required form.
Couple of comments, as seen below.
Also: I have no way to test this documentation because we do not have the infrastructure (like the various artifact repositories and an air-gapped installation of Che/CRW readily available.

src/main/pages/che-7/end-user-guide/assembly_using-gradle-artifact-repositories.adoc Outdated Show resolved Hide resolved
...in/pages/che-7/end-user-guide/proc_defining-maven-repositories-in-the-settings-xml-file.adoc Outdated
[id="defining-repositories-in-settings-xml_{context}"]
= Defining repositories in `settings.xml`

To use your own artifact repositories at `example.server.org`, you must modify the `settings.xml` file.
Copy link
Contributor

Choose a reason for hiding this comment

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

settings.xml is optional, so "modify" is not the correct term in most cases

...in/pages/che-7/end-user-guide/proc_defining-maven-repositories-in-the-settings-xml-file.adoc Outdated
To use your own artifact repositories at `example.server.org`, you must modify the `settings.xml` file.
Ensure, that the `settings.xml` is present in all the containers that use Maven tools, in particular the Maven container and the Java plugin container.

By default, `settings.xml` is located at the user home directory, but since user home directory is not on a persistent volume, each time you restart workplace, you must re-create the file.
Copy link
Contributor

Choose a reason for hiding this comment

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

No, it's not: it's located in <home dir>/.m2

...in/pages/che-7/end-user-guide/proc_defining-maven-repositories-in-the-settings-xml-file.adoc Outdated
To use your own artifact repositories at `example.server.org`, you must modify the `settings.xml` file.
Ensure, that the `settings.xml` is present in all the containers that use Maven tools, in particular the Maven container and the Java plugin container.

By default, `settings.xml` is located at the user home directory, but since user home directory is not on a persistent volume, each time you restart workplace, you must re-create the file.
Copy link
Contributor

Choose a reason for hiding this comment

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

"because the user home directory"

...in/pages/che-7/end-user-guide/proc_defining-maven-repositories-in-the-settings-xml-file.adoc Outdated

By default, `settings.xml` is located at the user home directory, but since user home directory is not on a persistent volume, each time you restart workplace, you must re-create the file.

To make the file persist between the restarts of the workspace, create a directory `/projects/maven/.m2` and move the `settings.xml` file in it. Then set the value of the `user.home` Java system property to `/projects/maven` in all your Maven containers.
Copy link
Contributor

Choose a reason for hiding this comment

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

This only makes sense as a workaround for issue eclipse-che/che#13318. If we don't mention why we're doing this workaround, folks will be confused.

src/main/pages/che-7/end-user-guide/proc_configuring-go-to-use-a-non-standard-registry.adoc Outdated

Athens is a Go module datastore and proxy with many configuration options, it can be configured to act only as a module datastore and not as a proxy. An admin can upload their Go modules to the Athens datastore and have them available across their Go projects. If a project tries to access a Go module that is not in the Athens datastore, the Go build fails.

* To work with Athens, configure the `GOPROXY` environment variable in the devfile of your Go container:
Copy link
Contributor

Choose a reason for hiding this comment

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

"CLI container". If people set it in the Go language sidecar, it has no effect.

@rkratky rkratky self-assigned this Apr 7, 2020
rkratky
rkratky requested changes Apr 7, 2020
View reviewed changes
src/main/pages/che-7/administration-guide/proc_using-npm-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/administration-guide/proc_using-npm-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/administration-guide/proc_using-npm-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/administration-guide/proc_using-npm-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/administration-guide/proc_using-npm-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/administration-guide/proc_using-npm-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/administration-guide/proc_using-npm-artifact-repositories.adoc Outdated Show resolved Hide resolved
...s/che-7/end-user-guide/assembly_using-artifact-repositories-in-a-restricted-environment.adoc Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/assembly_using-go-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/assembly_using-go-artifact-repositories.adoc Show resolved Hide resolved
@yhontyk yhontyk changed the title [WIP] Using different artifact repositories in a restricted environment Using different artifact repositories in a restricted environment Apr 7, 2020
rkratky
rkratky approved these changes Apr 7, 2020
View reviewed changes
src/main/pages/che-7/end-user-guide/assembly_using-gradle-artifact-repositories.adoc Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/assembly_using-gradle-artifact-repositories.adoc Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/assembly_using-maven-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/assembly_using-maven-artifact-repositories.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/assembly_using-maven-artifact-repositories.adoc Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/proc_using-self-signed-certificates-in-nuget-projects.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/proc_using-self-signed-certificates-in-nuget-projects.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/proc_using-self-signed-certificates-in-nuget-projects.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/proc_using-self-signed-certificates-in-nuget-projects.adoc Outdated Show resolved Hide resolved
src/main/pages/che-7/end-user-guide/proc_using-self-signed-certificates-in-python-projects.adoc Outdated Show resolved Hide resolved
Yana Hontyk and others added 2 commits April 7, 2020 14:21
@yhontyk yhontyk requested a review from tsmaeder April 7, 2020 12:29
@yhontyk yhontyk dismissed tsmaeder’s stale review April 8, 2020 08:07

I've addressed all of the comments. Will merge for now. Thank you.

@yhontyk yhontyk merged commit 4f9bd54 into eclipse-che:master Apr 8, 2020
@yhontyk yhontyk deleted the usingAirGap branch April 8, 2020 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rkratky rkratky rkratky approved these changes

@slemeur slemeur Awaiting requested review from slemeur

@themr0c themr0c Awaiting requested review from themr0c

@tsmaeder tsmaeder Awaiting requested review from tsmaeder

Assignees

@rkratky rkratky

Labels
None yet
Projects
None yet
Milestone
No milestone
4 participants
@yhontyk @rkratky @tsmaeder @che-bot