Skip to content

Commit

Permalink
Cleanup: updated README and environment-creation instructions
Browse files Browse the repository at this point in the history
Deleted construct.yaml (no longer used).

Change-Id: I6e7ed3c34593a898e04808bb08e4095b5575f98d
Reviewed-on: http://review.couchbase.org/c/tlm/+/162259
Reviewed-by: Blair Watt <blair.watt@couchbase.com>
Tested-by: Chris Hillery <ceej@couchbase.com>
  • Loading branch information
ceejatec committed Sep 24, 2021
1 parent b9bfffc commit 7e283b8
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 29 deletions.
23 changes: 12 additions & 11 deletions deps/packages/cbpy/README.md
@@ -1,16 +1,17 @@
This directory contains build steps to create "cbpy-installer", which is an
Anaconda-based installer for a customized Python 3 distribution. This
distribution will be installed on customer machines, and that installation
will be used for all Python 3 scripts that we ship.
This directory contains build steps to create "cbpy", which is a
standalone customized Python 3 package. This package will be installed
on customer machines as part of Server, and will be used for all Python
3 scripts that we ship.

Therefore, if you write any Python 3 scripts that require a new third-party
Python library, we must add it here to ensure that it is available in
production.

This used to be part of the Server build itself, but as it grew somewhat more
complex, it made sense to pull it out to a separate build. I'm making this a
cbdeps 1.0 package (ie, here in tlm/deps/packages rather than driven by a
separate manifest) because this actually IS effectively part of the Server
build. This also means we can keep the couchbase-server-specific Black Duck
manifest here in the same location as construct.yaml, making it easier to keep
them in sync.
This used to be part of the Server build itself, but as it grew somewhat
more complex, it made sense to pull it out to a separate build. I'm
making this a cbdeps 1.0 package (ie, here in tlm/deps/packages rather
than driven by a separate manifest) because this actually IS effectively
part of the Server build. This also means we can keep the
couchbase-server-specific Black Duck manifest here in the same location
as the environment files which define what python libraries are
included, making it easier to keep them in sync.
15 changes: 0 additions & 15 deletions deps/packages/cbpy/construct.yaml

This file was deleted.

@@ -1,7 +1,7 @@
components:

# Please keep these entries in the same order as the corresponding
# lines in construct.yaml, for ease of comparison
# lines in environment-*.txt, for ease of comparison
python:
bd-id: ee4d67e0-63f9-409d-a9be-1c30de64873d
versions: [ 3.9.6 ]
Expand Down
5 changes: 3 additions & 2 deletions deps/packages/cbpy/environment-base.txt
Expand Up @@ -24,8 +24,9 @@ readline=8.1.9
# the same version in cbdeps.
#
# The best way to create/update this list is to run the commands in
# cbpy_unix.sh / cbpy_windows.bat by hand until the comment "Populate cbpy
# environment". Then run
# cbpy_unix.sh / cbpy_windows.bat by hand up to and including
# "conda create -y -n cbpy". Then run:
# conda activate cbpy
# conda install -y -c ./conda-pkgs \
# python=3.9.5 chardet=4.0.0.9 ... # all explicit and faked deps
# conda update --update-all
Expand Down

0 comments on commit 7e283b8

Please sign in to comment.