ethyca / fidesdemo Goto Github PK
View Code? Open in Web Editor NEWStandalone project demonstrating the use of Fides in an example Flask application
License: Apache License 2.0
Standalone project demonstrating the use of Fides in an example Flask application
License: Apache License 2.0
Clicking on the Setting up fidesctl
link in the README goes to a 404 page.
A newer version of fidesops (1.8.1) has recently been released; the version in use by this repository is out of date.
Begin by updating the version in requirements.txt
:
fidesops==1.8.1
๐ Note | The version of fidesops must be pinned to an exact version number. |
---|
There may be additional changes needed in this repository to guarantee the inclusion of upstream feature enhancements, bug fixes, and/or to maintain compatibility. Be sure to review the changelog to ensure that any such code changes are made in tandem with the version bump.
A newer version of fidesops (1.7.1) has recently been released; the version in use by this repository is out of date.
Begin by updating the version in requirements.txt
:
fidesops==1.7.1
๐ Note | The version of fidesops must be pinned to an exact version number. |
---|
There may be additional changes needed in this repository to guarantee the inclusion of upstream feature enhancements, bug fixes, and/or to maintain compatibility. Be sure to review the changelog to ensure that any such code changes are made in tandem with the version bump.
After running make install
a comment states "Done! Run '. venv/bin/activate' to activate venv"
This could be made more clear to a potential user
Run make install
, see comment
The virtual environment should either be automatically created or noted as a step in the docs -> https://ethyca.github.io/fides/1.7.0/tutorial/
n/a
Will add more as needed potentially
fidesctl==1.8.1
was released. With that in mind, we should validate the demo workflow as is, and update accordingly.
This issue should focus on just the current functionality, not adding new content
Walk through the fidesctl
demo portion as is, and ensure no issues are present.
Also including new content, but that seems like it would distract from the goal of ensuring the fidesdemo is fully functional
https://github.com/ethyca/fides/releases/tag/1.8.1
Acceptance Criteria
A description of what the bug is.
I have setup the pre-requisites as required for fidesdemo.
When I execute the make install command, it gives me the below error while building the environment.
waghsac@WAGHSAC:~/fidesdemo$ make install
Bringing up docker containers...
WARN[0000] Found orphan containers ([fidesdemo-fidesops-1 fidesdemo-redis-1]) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up.
[+] Running 4/4
โ ฟ Container fidesdemo-db-1 Started 1.2s
โ ฟ Container fidesdemo-fidesctl-1 Started 2.6s
โ ฟ Container fidesdemo-redis-1 Started 1.0s
โ ฟ Container fidesdemo-fidesops-1 Started 1.3s
localhost:5432 - accepting connections
Creating virtual environment ./venv...
Installing project dependencies...
Collecting black>=21.9b0 (from -r requirements.txt (line 1))
Using cached https://files.pythonhosted.org/packages/2e/ef/a38a2189959246543e60859fb65bd3143129f6d18dfc7bcdd79217f81ca2/black-22.3.0-py3-none-any.whl
Collecting click>=7.0.0 (from -r requirements.txt (line 2))
Using cached https://files.pythonhosted.org/packages/4a/a8/0b2ced25639fb20cc1c9784de90a8c25f9504a7f18cd8b5397bd61696d7d/click-8.0.4-py3-none-any.whl
Collecting fidesctl==1.2.0 (from -r requirements.txt (line 3))
Could not find a version that satisfies the requirement fidesctl==1.2.0 (from -r requirements.txt (line 3)) (from versions: )
No matching distribution found for fidesctl==1.2.0 (from -r requirements.txt (line 3))
Makefile:32: recipe for target 'install' failed
make: *** [install] Error 1
I'm using Ubuntu 18.04 LTS on Windows.
A newer version of fidesops (1.7.2) has recently been released; the version in use by this repository is out of date.
Begin by updating the version in requirements.txt
:
fidesops==1.7.2
๐ Note | The version of fidesops must be pinned to an exact version number. |
---|
There may be additional changes needed in this repository to guarantee the inclusion of upstream feature enhancements, bug fixes, and/or to maintain compatibility. Be sure to review the changelog to ensure that any such code changes are made in tandem with the version bump.
A newer version of fidesops (1.8.2) has recently been released; the version in use by this repository is out of date.
Begin by updating the version in requirements.txt
:
fidesops==1.8.2
๐ Note | The version of fidesops must be pinned to an exact version number. |
---|
There may be additional changes needed in this repository to guarantee the inclusion of upstream feature enhancements, bug fixes, and/or to maintain compatibility. Be sure to review the changelog to ensure that any such code changes are made in tandem with the version bump.
The make clean
invocation is a bit aggressive; the current clean will execute docker system prune -a --volumes
, which will clear all resources and volumes in the docker storage-- including those unrelated to fidesdemo
. The command does require user input to proceed, but given the small amount of data in the postgres DB volume that this demo can generate it seems like a dangerous default clean.
Further, docker prune
is executed first, before cleaning venv and fides-related artifacts. Cancelling the docker prune
(like I did) then leaves these artifacts, which are perhaps more important to dispose of for the purpose of the demo.
make clean
should not prune volumes, and prompt the user to delete them themselves; it's better to leave a dangling volume than delete more than was installed by fidesdemo. (Which may happen with the prune anyways.)
Also, venv and fides-related cleaning should happen first, regardless of whether or the docker prune
behavior should change. This way, users can opt-out of the docker-prune
and still have the other files deleted.
In fact, make reset-db
already calls docker volume rm fidesdemo_postgres
, which should perhaps be the behavior replicated in make clean
.
One way to better target docker prune
may be to use the --filter=<key>=<value>
argument, if labels can be set in the docker-compose workflow for all docker resources created for the demo (e.g. containers, networks, volumes).
In ethyca/fidesops#61 we will update all keys to comply with Fides key validator such that only alphanumeric, _
, and .
chars allowed.
When that is merged, we will need to also update the following:
quickstart.py
Context: https://github.com/ethyca/fidesops/pull/61/files#r748442186
Many of the make targets leverage some handy shell techniques that only work on UNIX systems, but I'd like to get this demo project working smoothly on Windows.
Attempt to run the minimal demo targets on Windows:
make install
make demo
These commands should run successfully and the demo environment should be fully usable.
A newer version of fidesops (1.8.0) has recently been released; the version in use by this repository is out of date.
Begin by updating the version in requirements.txt
:
fidesops==1.8.0
๐ Note | The version of fidesops must be pinned to an exact version number. |
---|
There may be additional changes needed in this repository to guarantee the inclusion of upstream feature enhancements, bug fixes, and/or to maintain compatibility. Be sure to review the changelog to ensure that any such code changes are made in tandem with the version bump.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.